VPPhoton MembersVirtual Photonics - VTS Library
Virtual Photonics

The Photon type exposes the following members.
Constructors

  NameDescription
Public methodPhoton 
default constructor for Photon
Public methodPhoton(Position, Direction, ITissue, Int32, Random)
Class that keeps a photon's data as it moves through the tissue
Back to Top
Methods

  NameDescription
Public methodAbsorbAnalog
Method to check for absorption according to analog random walk process
Public methodAbsorbContinuous
Method to deweight for absorption according to continuous absorption weighting (CAW) random walk process
Public methodAbsorbDiscrete
Method to deweight for absorption according to discrete absorption weighting (DAW) random walk process
Public methodCrossRegionOrReflect
Method that determines whether photon reflects or refracts across interface. When this method is called photon is sitting on boundary of region and CurrentRegionIndex is Index of region photon had been in.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodMove
method to move the photon to its next location
Public methodScatter1D
Method to scatter bidirectionally
Public methodScatterHenyeyGreenstein
Method to scatter according to Henyey-Greenstein scatter function
Public methodSetStepSize
method that determines photon's step size based on the RegionScatterLength (1/mus or 1/mut depending on CAW or DAW)
Public methodTestDeath
Method to test for death of the photon
Public methodTestWeightAndDistance
Method that kills photon due to Russian Roulette, maximum path length, etc.
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodToUnmanagedPhoton (Defined by UnmanagedPhotonExtension.)
Back to Top
Properties

  NameDescription
Public propertyAbsorb
absorb action: analog, discrete, continuous
Public propertyCurrentRegionIndex
tissue region index where photon current is
Public propertyCurrentTrackIndex
index of current track of photon
Public propertyDP
photon data point has position, direction etc. info
Public propertyHistory
PhotonHistory has list of PhotonDataPoints and SubRegionCollisionInfo
Public propertyS
path length of current track, gets updated when passing tissue boundary
Public propertyScatter
scatter action: Henyey-Greenstein, bidirectional, Mie
Public propertySLeft
path length left after crossing tissue boundary
Back to Top
See Also