VPCustomCircularSource MembersVirtual Photonics - VTS Library
Virtual Photonics

The CustomCircularSource type exposes the following members.
Constructors

  NameDescription
Public methodCustomCircularSource
Returns an instance of Custom Circular Source with specified length and width, source profile (Flat/Gaussian), polar and azimuthal angle range, new source axis direction, translation, and inward normal ray rotation
Back to Top
Methods

  NameDescription
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.)
Protected methodGetFinalDirection
Returns direction for a given position
(Overrides CircularSourceBase GetFinalDirection(Position).)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetNextPhoton
Implements Get next photon
(Inherited from CircularSourceBase.)
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 methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Fields

  NameDescription
Protected field_beamRotationFromInwardNormal
Beam rotation from inward normal
(Inherited from CircularSourceBase.)
Protected field_initialTissueRegionIndex
Initial tissue region index
(Inherited from CircularSourceBase.)
Protected field_innerRadius
The inner radius of the circular source
(Inherited from CircularSourceBase.)
Protected field_newDirectionOfPrincipalSourceAxis
New source axis direction
(Inherited from CircularSourceBase.)
Protected field_outerRadius
The outer radius of the circular source
(Inherited from CircularSourceBase.)
Protected field_rotationAndTranslationFlags
Source rotation and translation flags
(Inherited from CircularSourceBase.)
Protected field_sourceProfile
Source profile type
(Inherited from CircularSourceBase.)
Protected field_translationFromOrigin
New source location
(Inherited from CircularSourceBase.)
Back to Top
Properties

  NameDescription
Public propertyRng
The random number generator used to create photons. If not assigned externally, a Mersenne Twister (MathNet.Numerics.Random.MersenneTwister) will be created with a seed of zero.
(Inherited from CircularSourceBase.)
Back to Top
See Also