VPEllipsoidRegion MembersVirtual Photonics - VTS Library
Virtual Photonics

The EllipsoidRegion type exposes the following members.
Constructors

  NameDescription
Public methodEllipsoidRegion 
default constructor defines sphere with radius 0.5mm and center (0,0,1)
Public methodEllipsoidRegion(Position, Double, Double, Double, OpticalProperties)
class specifies ellipsoid tissue region (x-xc)^2/a^2 + (y-yc)^2/b^2 + (z-zc)^2/c^2 = 1 where center is (xc,yc,zc) and semi-axis along x-, y-, z- axes are a, b, c, respectively.
Back to Top
Methods

  NameDescription
Public methodContainsPosition
method to determine if given Position lies within ellipsoid
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 methodOnBoundary
method to determine if given Position lies on boundary of ellipsoid
Public methodRayIntersectBoundary
method to determine if photon track or ray intersects boundary of ellipsoid
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodIsAir
Method to determine if tissue region is air or not
(Defined by ITissueRegionExtensions.)
Back to Top
Properties

  NameDescription
Public propertyCenter
center of ellipsoid
Public propertyDx
distance from center to x-axis radius
Public propertyDy
distance from center to y-axis radius
Public propertyDz
distance from center to z-axis radius
Public propertyRegionOP
optical properties of ellipsoid
Back to Top
See Also