Index
CEnvelope
 CEnvelope
 
 
 
  Non axial propagation:
  1. use reference wavevector component + put 2D tilted Gauss - this is
  optimal from the point of wiew of number of points required
  2. use changePropagationDirection  but remember to make it account
  for refractive index of the material (use put to put what you want
  and than rotate) in this case the required range of KX or KY space
  can be large (not good for big beams - even if the beam is not to
  divergent the direction change implies shift in KX, KY space - this
  has to be in KX/KY space range, the 1. th method overcomes this
  problem).
  3.
Class Details
Superclasses CH5Serializable
Sealed false
Construct on load false
Constructor Summary
CEnvelope (sName, hSpace) 
Property Summary
m_fRefAzimuth with respect to the z - simulation 
m_fRefFreq  
m_fRefInclination with respect to the z - simulation (theta) 
m_fRefKX  
m_fRefKY  
m_fXWidth  
m_fYWidth  
m_hSpace  
m_hTransform  
m_mGrid in Fourier of Conjugate spaces. 
m_sName  
m_sPolarization  
Method Summary
  addSpatialChirp fChirp [m s] = dx / d omega 
  addSpectralPhase function addSpectralPhase(obj, vPhaseTaylorExpansionCoeff) 
  addlistener Add listener for event. 
  checkWLRange  
  delete Delete a handle object. 
  energy fEnergy = energy() - assuming pulse is in vacuum 
protected   energyAF Gaussian beam assumed 
protected   energyAFKR  
protected   energyAFKX Gaussian shape in Y dim assumed 
protected   energyAFKXKY  
  energySpectralDensity vPower = energySpectralDensity() - assuming pulse is in vacuum 
protected   energyT Gaussian beam assumed 
protected   energyTR  
protected   energyTX Gaussian shape in Y dim assumed 
protected   energyTXY  
  eq == (EQ) Test handle equality. 
  findobj Find objects matching specified conditions. 
  findprop Find property of MATLAB handle object. 
Static   fromH5  
  ge >= (GE) Greater than or equal relation for handles. 
  getAF  
  getDeepCopy  
  getDimByName  
  getEnergy fEnergy = getEnergy(obj, fMaterialRefractiveIndex) 
Static   getFile  
  getKR  
  getR  
  getRealAngularFrequency  
  getRealKX  
  getRealKY  
  getRealWavelengths  
  getRelativeAngularFrequency  
  getRelativeKX  
  getRelativeKY  
  getShallowCopy  
  getSpecSI mSpecSI = getSpecSI(obj) 
  getTime  
  getX  
  getY  
  gt > (GT) Greater than relation for handles. 
  intensity  
Sealed   isvalid Test handle validity. 
  le <= (LE) Less than or equal relation for handles. 
  lt < (LT) Less than relation for handles. 
  ne ~= (NE) Not equal relation for handles. 
  notify Notify listeners of event. 
  perseval fPersevalFactor = perseval() 
  plot  
  plus env3 = env1 + env2 
  polarization  
  power vPower = power() - assuming pulse is in vacuum 
protected   powerAF Gaussian beam assumed 
protected   powerAFKR should also be ok for XY returns a number 
protected   powerAFKX Gaussian shape in Y dim assumed 
protected   powerAFKXKY should also be ok for XY returns a number 
protected   powerT Gaussian beam assumed 
protected   powerTR should also be ok for XY returns a number 
protected   powerTX Gaussian shape in Y dim assumed 
protected   powerTXY should also be ok for XY returns a number 
  pulseEnergy  
  put (fPulseEnergy, hPulseComposer) 3D(TXY) or 2D(TR) 
  putGauss (fPulseEnergy, fPulseTimeFWHM, fXWidth, fYWidth) 
  putGauss1D  
protected   putGauss1D_  
  putGauss3D  
protected   putGauss3D_  
  putHermiteGauss (fPulseEnergy, fPulseTimeFWHM, fCurrentBeamWidth, iXOrder, iYOrder, fWavelength) 
  putLaguerreGauss (fPulseEnergy, fPulseTimeFWHM, fCurrentBeamWidth, iRadialOrder, iAzimuthalOrder, fWavelength) 
  putSuperGauss (fPulseEnergy, fPulseTimeFWHM, fXWidth, fYWidth, iTimeSuperGaussOrder) 
protected   putSuperGauss1D_ putSuperGauss(fPulseEnergy, fPulseTimeFWHM, fXWidth, fYWidth, iTimeSuperGaussOrder) 
protected   putSuperGauss3D_ putSuperGauss(fPulseEnergy, fPulseTimeFWHM, fXWidth, fYWidth, iTimeSuperGaussOrder) 
  putTiltedGauss this one seems wrong, although phase might be all right 
  putTiltedGauss2 in vacuum 
  referenceAngularFrequency  
  referenceWavelength  
  referenceWavevectorComponent fReferenceWavevectorComponent = referenceWavevectorComponent(sComponent) 
  serialize  
  setPolarization  
  setReferenceFrequency  
  setReferenceWavelength assert(isempty(obj.m_fRefFreq), 'Reference Wavelength already set.'); 
  setReferenceWavevectorComponent (sComponent, fReferenceWavevectorComponent) 
  shiftInSpace (sAxis, vShift) 
  shiftSpectrum fAFShift - if positive the env frequency will be higher. 
  spectrum vSpec = spectrum() in vacuum 
protected   spectrumT J s 
protected   spectrumTR should also be ok for XY returns a number 
protected   spectrumTX  
protected   spectrumTXY should also be ok for XY returns a number 
  tilt (fTiltAngle, fAzimuthPhi) 
  toH5 (sH5FilePath) 
  transform  
Event Summary
ObjectBeingDestroyed Notifies listeners that a particular object has been destroyed.