 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
An instance of the Probe class can be spawned from a Simulation object to represent a probe in the simulation, allowing to retrieve its attributes. More...
Public Member Functions | |
| __init__ (self, simulation, index) | |
| The constructor accepts the Simulation instance in which this probe resides, and the zero-based index of the probe in the probe system. | |
| formType (self) | |
| This function returns the type of the form associated with the probe, or the empty string if the probe is not a form probe. | |
| name (self) | |
| This function returns the name of the probe as specified in the ski file, as a string. | |
| Public Member Functions inherited from pts.simulation.simulation._SimulationEntity | |
| __init__ (self, simulation, xpath) | |
| The constructor accepts the Simulation instance in which this entity resides, and the xpath of the entity in the ski file for the simulation. | |
| getBoolAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as a Boolean value. | |
| getFloatAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as a floating point number representing a dimensionless quantity. | |
| getIntAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as an integer number. | |
| getQuantityAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as an astropy scalar quantity with given units. | |
| getQuantityListAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as an astropy quantity array with given units, assuming comma-separated values in the attribute value. | |
| getStringAttribute (self, attribute) | |
| This function returns the value of the specified entity attribute as a string. | |
| outFilePaths (self, fileType=None) | |
| This function returns a list of absolute paths to the output files associated with this entity. | |
| prefix (self) | |
| This function returns the prefix for the simulation with which this entity is associated. | |
| type (self) | |
| This function returns the type of the entity, i.e. | |
| wavelengthBinWidths (self) | |
| This function returns an astropy quantity array containing the wavelength bin widths of the wavelength grid associated with this entity, or raises an error if this information cannot be obtained. | |
| wavelengthIndices (self, wavelengths) | |
| This function uses the wavelengths() function to load the characteristic wavelengths of the wavelength grid associated with this entity, and then determines the zero-based grid index corresponding to (i.e. | |
| wavelengths (self) | |
| This function returns an astropy quantity array containing the characteristic wavelengths of the wavelength grid associated with this entity, or raises an error if this information cannot be obtained. | |
Additional Inherited Members | |
| Protected Attributes inherited from pts.simulation.simulation._SimulationEntity | |
| _simulation | |
| _xpath | |
An instance of the Probe class can be spawned from a Simulation object to represent a probe in the simulation, allowing to retrieve its attributes.
See the Simulation.probes() function.
| pts.simulation.simulation.Probe.__init__ | ( | self, | |
| simulation, | |||
| index ) |
The constructor accepts the Simulation instance in which this probe resides, and the zero-based index of the probe in the probe system.
It is intended to be invoked only from within the Simulation class.
| pts.simulation.simulation.Probe.formType | ( | self | ) |
This function returns the type of the form associated with the probe, or the empty string if the probe is not a form probe.
| pts.simulation.simulation.Probe.name | ( | self | ) |
This function returns the name of the probe as specified in the ski file, as a string.