The SKIRT project
advanced radiative transfer for astrophysics
AllSkyProjectionForm Class Reference

#include <AllSkyProjectionForm.hpp>

Inheritance diagram for AllSkyProjectionForm:

Public Member Functions

double crossX () const
double crossY () const
double crossZ () const
int numPixelsY () const
double observerX () const
double observerY () const
double observerZ () const
AllSkyProjectionprojection () const
double upX () const
double upY () const
double upZ () const
void writeQuantity (const ProbeFormBridge *bridge) const override
Public Member Functions inherited from SimulationItem
template<class T>
T * find (bool setup=true) const
template<class T>
T * interface (int levels=-999999, bool setup=true) const
virtual string itemName () const
void setup ()
string typeAndName () const
Public Member Functions inherited from Item
 Item (const Item &)=delete
virtual ~Item ()
void addChild (Item *child)
const vector< Item * > & children () const
virtual void clearItemListProperty (const PropertyDef *property)
void destroyChild (Item *child)
virtual bool getBoolProperty (const PropertyDef *property) const
virtual vector< double > getDoubleListProperty (const PropertyDef *property) const
virtual double getDoubleProperty (const PropertyDef *property) const
virtual string getEnumProperty (const PropertyDef *property) const
virtual int getIntProperty (const PropertyDef *property) const
virtual vector< Item * > getItemListProperty (const PropertyDef *property) const
virtual ItemgetItemProperty (const PropertyDef *property) const
virtual string getStringProperty (const PropertyDef *property) const
int getUtilityProperty (string name) const
virtual void insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Itemoperator= (const Item &)=delete
Itemparent () const
virtual void removeFromItemListProperty (const PropertyDef *property, int index)
virtual void setBoolProperty (const PropertyDef *property, bool value)
virtual void setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void setDoubleProperty (const PropertyDef *property, double value)
virtual void setEnumProperty (const PropertyDef *property, string value)
virtual void setIntProperty (const PropertyDef *property, int value)
virtual void setItemProperty (const PropertyDef *property, Item *item)
virtual void setStringProperty (const PropertyDef *property, string value)
void setUtilityProperty (string name, int value)
virtual string type () const

Protected Member Functions

 AllSkyProjectionForm ()
void setupSelfBefore () override
Protected Member Functions inherited from GenericForm
 GenericForm ()
Protected Member Functions inherited from Form
 Form ()
Protected Member Functions inherited from SimulationItem
 SimulationItem ()
virtual bool offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void setupSelfAfter ()
Protected Member Functions inherited from Item
 Item ()

Private Types

using BaseType
using ItemType

Private Attributes

double _crossX
double _crossY
double _crossZ
const double & _Cx
const double & _Cy
const double & _Cz
int _numPixelsY
double _observerX
double _observerY
double _observerZ
const double & _Ox
const double & _Oy
const double & _Oz
AllSkyProjection_projection
double _upX
double _upY
double _upZ
const double & _Ux
const double & _Uy
const double & _Uz

Friends

class ItemRegistry

Detailed Description

AllSkyProjectionForm represents a generic probe form. Refer to the ProbeFormBridge class for more information about probes and forms.

This particular form outputs a FITS file representing an all-sky projection of the quantity being probed as seen from the given position and centered towards the given direction. The position can be inside the model. The map has a 2:1 aspect ratio (with square pixels) and uses the user-selected projection to project the complete sky on the rectangular image. Pixels outside of the mapped region are set to zero.

The FITS file contains a number of image frames corresponding to the number of components in a value of the quantity being probed (i.e. 1 for scalar quantities, 3 for vector quantities, and N for compound quantities). In case of a vector quantity, the three image frames represent the velocity vector components in the frame of the projection, i.e. the two components projected on the x and y axes of the projection plane and the component perpendicular to it, where positive values indicate vectors pointing away from the viewer.

This class sends a ray through the model for each output pixel center, calculating the projection by accumulating information along that ray. Consequently, it ignores small features in the model that project on the pixel but do not overlap the pixel center. To improve accuracy, decrease the pixel size by increasing the number of pixels along each axis.

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ AllSkyProjectionForm()

AllSkyProjectionForm::AllSkyProjectionForm ( )
inlineprotected

Default constructor for concrete Item subclass AllSkyProjectionForm: "all-sky projection at a position inside the model".

Member Function Documentation

◆ crossX()

double AllSkyProjectionForm::crossX ( ) const
inline

This function returns the value of the discoverable double property crossX: "the position of the crosshair, x component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "0".

◆ crossY()

double AllSkyProjectionForm::crossY ( ) const
inline

This function returns the value of the discoverable double property crossY: "the position of the crosshair, y component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "0".

◆ crossZ()

double AllSkyProjectionForm::crossZ ( ) const
inline

This function returns the value of the discoverable double property crossZ: "the position of the crosshair, z component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "0".

◆ numPixelsY()

int AllSkyProjectionForm::numPixelsY ( ) const
inline

This function returns the value of the discoverable integer property numPixelsY: "the number of image pixels in the vertical (shortest) direction".

The minimum value for this property is "25".

The maximum value for this property is "10000".

The default value for this property is given by the conditional value expression "250".

◆ observerX()

double AllSkyProjectionForm::observerX ( ) const
inline

This function returns the value of the discoverable double property observerX: "the position of the observer, x component".

This property represents a physical quantity of type "length".

◆ observerY()

double AllSkyProjectionForm::observerY ( ) const
inline

This function returns the value of the discoverable double property observerY: "the position of the observer, y component".

This property represents a physical quantity of type "length".

◆ observerZ()

double AllSkyProjectionForm::observerZ ( ) const
inline

This function returns the value of the discoverable double property observerZ: "the position of the observer, z component".

This property represents a physical quantity of type "length".

◆ projection()

AllSkyProjection * AllSkyProjectionForm::projection ( ) const
inline

This function returns the value of the discoverable item property projection: "the projection used for mapping the sky to a rectangle".

The default value for this property is given by the conditional value expression "HammerAitoffProjection".

◆ setupSelfBefore()

void AllSkyProjectionForm::setupSelfBefore ( )
overrideprotectedvirtual

This function verifies that all attribute values have been appropriately set.

Reimplemented from SimulationItem.

◆ upX()

double AllSkyProjectionForm::upX ( ) const
inline

This function returns the value of the discoverable double property upX: "the upwards direction, x component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "0".

◆ upY()

double AllSkyProjectionForm::upY ( ) const
inline

This function returns the value of the discoverable double property upY: "the upwards direction, y component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "0".

◆ upZ()

double AllSkyProjectionForm::upZ ( ) const
inline

This function returns the value of the discoverable double property upZ: "the upwards direction, z component".

This property represents a physical quantity of type "length".

The default value for this property is given by the conditional value expression "1".

◆ writeQuantity()

void AllSkyProjectionForm::writeQuantity ( const ProbeFormBridge * bridge) const
overridevirtual

This function causes the form to output file(s) as described in the class header for the quantity being probed according to the information provided by the specified ProbeFormBridge instance.

Implements Form.


The documentation for this class was generated from the following file: