VPVts.MonteCarlo NamespaceVirtual Photonics - VTS Library
Virtual Photonics
 
Classes

  ClassDescription
Public classAbsorptionWeightingMethods
Public classAOfRhoAndZDetectorInput
DetectorInput for Absorption(r,z)
Public classATotalDetectorInput
DetectorInput for total absorption
Public classCustomCircularSourceInput
Implements ISourceInput. Defines input data for CustomCircularSource implementation including inner and outer radius, source profile, polar angle range, azimuthal angle range, direction, position, inward normal beam rotation and initial tissue region index.
Public classCustomEllipticalSourceInput
Implements ISourceInput. Defines input data for CustomEllipticalSource implementation including a and b parameter, source profile, polar angle range, azimuthal angle range, direction, position, inward normal beam rotation, and initial tissue region index.
Public classCustomLineSourceInput
Implements ISourceInput. Defines input data for CustomLineSource implementation including line length, source profile, polar angle range, azimuthal angle range, direction, position, inward normal beam rotation and initial tissue region index.
Public classCustomPointSourceInput
Implements ISourceInput. Defines input data for CustomLineSource implementation including polar angle range, azimuthal angle range, emitting point location, direction and initial tissue region index.
Public classCustomRectangularSourceInput
Implements ISourceInput. Defines input data for CustomRectangularSource implementation including length, width, source profile, polar angle range, azimuthal angle range, direction, position, inward normal beam rotation and initial tissue region index.
Public classCustomSurfaceEmittingSphericalSourceInput
Implements ISourceInput. Defines input data for CustomSurfaceEmittingSphericalSource implementation including radius, source profile, polar angle range, azimuthal angle range, direction, position and initial tissue region index.
Public classCustomVolumetricCuboidalSourceInput
Implements ISourceInput. Defines input data for CustomVolumetricCuboidalSource implementation including length, width, height, source profile, polar angle range, azimuthal angle range, direction, position and initial tissue region index.
Public classCustomVolumetricEllipsoidalSourceInput
Implements ISourceInput. Defines input data for CustomVolumetricEllipsoidalSource implementation including a,b and c parameters, source profile, polar angle range, azimuthal angle range, direction, position and initial tissue region index.
Public classDirectionalCircularSourceInput
Implements ISourceInput. Defines input data for DirectionalCircularSource implementation including converging/diverging angle, inner and outer radius, source profile, direction, position, inward normal beam rotation and initial tissue region index.
Public classDirectionalEllipticalSourceInput
Implements ISourceInput. Defines input data for DirectionalellipticalSource implementation including converging/diverging angle, a and b parameters, source profile, direction, position, inward normal beam rotation and initial tissue region index.
Public classDirectionalLineSourceInput
Implements ISourceInput. Defines input data for DirectionalLineSource implementation including converging/diverging angle, line length, source profile, direction, position, inward normal beam rotation and initial tissue region index.
Public classDirectionalPointSourceInput
Implements ISourceInput. Defines input data for CustomLineSource implementation including converging/diverging angle, emitting point location, direction and initial tissue region index.
Public classDirectionalRectangularSourceInput
Implements ISourceInput. Defines input data for DirectionalRectangularSource implementation including converging/diverging angle, length, width, source profile, direction, position, inward normal beam rotation and initial tissue region index.
Public classdMCdROfRhodMuaDetectorInput
DetectorInput for dMC dR(r)/dMua.
Public classdMCdROfRhodMuaDetectorInputValidation
This verifies dMCROfRhoDMuaDetectorInput
Public classdMCdROfRhodMusDetectorInput
DetectorInput for dMC dR(r)/dMus.
Public classdMCdROfRhodMusDetectorInputValidation
This verifies dMCROfRhoDMusDetectorInput
Public classFluenceOfRhoAndZAndTimeDetectorInput
DetectorInput for Flu(r,z,t)
Public classFluenceOfRhoAndZDetectorInput
DetectorInput for Flu(r,z)
Public classFluenceOfXAndYAndZDetectorInput
DetectorInput for Flu(x,y,z)
Public classIsotropicLineSourceInput
Implements ISourceInput. Defines input data for IsotropicLineSource implementation including line length, source profile, direction, position, inward normal beam rotation and initial tissue region index.
Public classIsotropicPointSourceInput
Implements ISourceInput. Defines input data for IsotropicPointSource implementation including emitting position, direction and initial tissue region index.
Public classIsotropicVolumetricCuboidalSourceInput
Implements ISourceInput. Defines input data for IsotropicVolumetricCuboidalSource implementation including length, width, height, source profile, direction, position, and initial tissue region index.
Public classIsotropicVolumetricEllipsoidalSourceInput
Implements ISourceInput. Defines input data for IsotropicVolumetricCuboidalSource implementation including length, width, height, source profile, direction, position, and initial tissue region index.
Public classLambertianSurfaceEmittingCuboidalSourceInput
Implements ISourceInput. Defines input data for LambertianSurfaceEmittingCuboidalSource implementation including length, width, height, source profile, direction, position, and initial tissue region index.
Public classLambertianSurfaceEmittingCylindricalFiberSourceInput
Implements ISourceInput. Defines input data for LambertianSurfaceEmittingCylindricalFiberSource implementation including tube radius, tube height, curved surface efficiency, bottom surface efficiency, direction, position, and initial tissue region index.
Public classLambertianSurfaceEmittingSphericalSourceInput
Implements ISourceInput. Defines input data for LambertianSurfaceEmittingSphericalSource implementation including radius, position and initial tissue region index.
Public classLambertianSurfaceEmittingTubularSourceInput
Implements ISourceInput. Defines input data for LambertianSurfaceEmittingTubularSource implementation including tube radius, height, direction, position and initial tissue region index.
Public classMonteCarloSimulation
Provides main processing for Monte Carlo simulation.
Public classMultiEllipsoidTissueInput
Implements ITissueInput. Defines input to SingleEllipsoidTissue class.
Public classMultiLayerTissueInput
Implements ITissueInput. Defines input to MultiLayerTissue class.
Public classMultiLayerTissueInputValidation
This verifies the structure of a MultiLayerTissue
Public classPhoton
Handles all data and methods necessary to photon biography generation.
Public classPhotonHistory
Stores list of PhotonDataPoint that captures one photon's biography data.
Public classpMCROfFxAndTimeDetectorInput
DetectorInput for pMC R(fx, t)
Public classpMCROfFxDetectorInput
DetectorInput for pMC R(fx).
Public classpMCROfRhoAndTimeDetectorInput
DetectorInput for pMC R(r,time).
Public classpMCROfRhoDetectorInput
DetectorInput for pMC R(r).
Public classPostProcessorInput
Public classPostProcessorInputProvider
Implements various commonly used PostProcessorInput classes for various tissue types.
Public classPostProcessorInputValidation
This class validates whether the fields in PostProcessorInput have been specified correctly or not.
Public classRadianceOfRhoAndZAndAngleDetectorInput
DetectorInput for volume detector R(rho,z,angle)
Public classRadianceOfRhoDetectorInput
DetectorInput for surface detector Radiance(rho)
Public classRadianceOfXAndYAndZAndThetaAndPhiDetectorInput
DetectorInput for volume detector Radiance(x, y, z, theta, phi)
Public classRDiffuseDetectorInput
DetectorInput for Rdiffuse
Public classReflectedMTOfRhoAndSubregionHistDetectorInput
DetectorInput for Flu(r,z)
Public classReflectedTimeOfRhoAndSubregionHistDetectorInput
DetectorInput for Flu(r,z)
Public classROfAngleDetectorInput
DetectorInput for R(angle)
Public classROfFxAndTimeDetectorInput
DetectorInput for R(r,t)
Public classROfFxDetectorInput
DetectorInput for R(fx)
Public classROfRhoAndAngleDetectorInput
DetectorInput for R(r,angle)
Public classROfRhoAndOmegaDetectorInput
DetectorInput for R(r,omega)
Public classROfRhoAndTimeDetectorInput
DetectorInput for R(r,t)
Public classROfRhoDetectorInput
DetectorInput for R(r)
Public classROfXAndYDetectorInput
DetectorInput for R(x,y)
Public classRSpecularDetectorInput
DetectorInput for specular reflectance
Public classSimulationInput
Defines input to the Monte Carlo simulation. This includes the output file name, number of photons to execute (N), source, tissue and detector definitions.
Public classSimulationInputProvider
Implements various commonly used SimulationInput classes for various tissue types.
Public classSimulationInputValidation
This sanity checks SimulationInput
Public classSimulationOptions
Designates random number generator, absorption weighting type and flags input to the Monte Carlo simulation (e.g. tally second moment and specify seed for RNG).
Public classSimulationOutput
Helper class to surface the results of a Monte Carlo simulation in a user-friendly (strongly-typed) way
Public classSimulationStatistics
This class captures informational statistics of the MC simulation executed
Public classSingleEllipsoidTissueInput
Implements ITissueInput. Defines input to SingleEllipsoidTissue class.
Public classSingleEllipsoidTissueInputValidation
This verifies that the ellipsoid is entirely contained within tissue layer, that only one tissue layer is defined, and that the refractive index of the tissue layer and ellipsoid match.
Public classSourceInputProvider
Implements various commonly used SourceInput classes.
Public classTDiffuseDetectorInput
DetectorInput for Tdiffuse
Public classTOfAngleDetectorInput
DetectorInput for Time(angle)
Public classTOfRhoAndAngleDetectorInput
DetectorInput for R(r,angle)
Public classTOfRhoDetectorInput
DetectorInput for T(r)
Public classUnmanagedHistoryExtension
Public classUnmanagedIO
Public classUnmanagedLayerExtension
Public classUnmanagedMonteCarloSimulation
Public classUnmanagedOutputExtension
Public classUnmanagedPhotonExtension
Public classUnmanagedSourceDefinitionExtension
Public classUnmanagedTissueExtension
Structures

  StructureDescription
Public structureUnmanagedDetectorDefinition
Public structureUnmanagedFlags
Public structureUnmanagedHistory
Public structureUnmanagedLayer
Public structureUnmanagedOutput
Public structureUnmanagedPhoton
Public structureUnmanagedSourceDefinition
Public structureUnmanagedTissue
Interfaces

  InterfaceDescription
Public interfaceIDetector
Properties and methods that all IDetectors must implement
Public interfaceIDetector T 
Defines a contract for Monte Carlo tallies.
Public interfaceIDetectorController
Interface for Controller classes that manage the detectors.
Public interfaceIDetectorInput
Defines a contract for DetectorInput classes.
Public interfaceIHistoryDetector
Properties and methods that all IDetectors must implement
Public interfaceIHistoryDetector T 
Defines a contract for Monte Carlo tallies.
Public interfaceIpMCDetectorInput
This is a contract for perturbation Monte Carlo (pMC) detector inputs. It describes the additional properties from IDetectorInput needed to perform the pMC detection.
Public interfaceISource
Defines a contract for Source classes for Monte Carlo simulation.
Public interfaceISourceInput
Defines a contract for SourceInput classes.
Public interfaceITissue
Defines a contract for Tissue classes in Monte Carlo simulation.
Public interfaceITissueInput
Defines a contract for TissueInput.
Public interfaceITissueRegion
Defines contract for TissueRegion classes.
Public interfaceIVirtualBoundary
Defines a contract for Virtual Boundary classes in Monte Carlo simulation.
Enumerations

  EnumerationDescription
Public enumerationAngleDistributionType
Source angle distribution types
Public enumerationBoundaryHitType
Flag indicating whether the photon hit a actual tissue boundary or a virtual boundary
Public enumerationDatabaseType
This should match VirtualBoundaryType one for one. Commented out ones have not made it to the white list yet.
Public enumerationPhotonStateType
PhotonStateType is a bitmap of Photon.StateFlag. Combinations of bits indicate the current state of the photon. These states communicate what to do with the photon. ref: http://www.codeproject.com/Articles/37921/Enums-Flags-and-Csharp-Oh-my-bad-pun.aspx or http://stackoverflow.com/questions/93744/most-common-c-bitwise-operations
Public enumerationSourceOrientationType
Orientation types of the source
Public enumerationSourceProfileType
Source beam profile types
Public enumerationSourceType
Source types defined organized by dimension and geometric type
Public enumerationTallyType
The different types of tallies available
Public enumerationTissueType
Tissue types
Public enumerationVirtualBoundaryType
Virtual boundaries are entities upon which detectors are attached. Each detector is associated with one and only one of the following types. The VBs have a spatial location (surface or volume) and sometimes have a direction.