#include <PlanarCutsForm.hpp>

Inheritance diagram for PlanarCutsForm:

[legend]

Public Member Functions
double	maxX () const

double	maxY () const

double	maxZ () const

double	minX () const

double	minY () const

double	minZ () const

int	numPixelsX () const

int	numPixelsY () const

int	numPixelsZ () const

double	positionX () const

double	positionY () const

double	positionZ () const

void	writeQuantity (const ProbeFormBridge *bridge) const override

virtual void	writeQuantity (const ProbeFormBridge *bridge) const =0

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 Item *	getItemProperty (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)

Item &	operator= (const Item &)=delete

Item *	parent () 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

Static Public Member Functions
static void	writePlanarCut (const ProbeFormBridge *bridge, bool xd, bool yd, bool zd, const Box &box, double xp, double yp, double zp, int xn, int yn, int zn)

Protected Member Functions
	PlanarCutsForm ()

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 ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = GenericForm

using	ItemType = PlanarCutsForm

Private Attributes
double	_maxX

double	_maxY

double	_maxZ

double	_minX

double	_minY

double	_minZ

int	_numPixelsX

int	_numPixelsY

int	_numPixelsZ

double	_positionX

double	_positionY

double	_positionZ

Friends
class	ItemRegistry

Detailed Description

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

This particular form outputs three FITS files representing cuts through the spatial domain of the simulated model along three planes parallel to the coordinate planes. The user can configure the extent of the spatial domain to be considered, the offset of each cut plane from the corresponding coordinate plane, and the number of pixels in each direction. By default, the cuts are centered on the origin of the model coordinate frame.

Each of the three FITS files 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 cut, i.e. the two components projected on the x and y axes of the cut and the component perpendicular to the cut, where positive values indicate vectors pointing away from the viewer.

This class samples the model at each pixel center in the output cut. Consequently, it ignores small features in the model that intersect 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

◆ PlanarCutsForm()

PlanarCutsForm::PlanarCutsForm ( )

inlineprotected

Default constructor for concrete Item subclass PlanarCutsForm : "configurable planar cuts parallel to the coordinate planes" .

Member Function Documentation

◆ maxX()

PlanarCutsForm::maxX ( ) const

inline

This function returns the value of the discoverable double property maxX : "the end point of the box in the X direction" .

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

◆ maxY()

PlanarCutsForm::maxY ( ) const

inline

This function returns the value of the discoverable double property maxY : "the end point of the box in the Y direction" .

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

◆ maxZ()

PlanarCutsForm::maxZ ( ) const

inline

This function returns the value of the discoverable double property maxZ : "the end point of the box in the Z direction" .

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

◆ minX()

PlanarCutsForm::minX ( ) const

inline

This function returns the value of the discoverable double property minX : "the start point of the box in the X direction" .

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

◆ minY()

PlanarCutsForm::minY ( ) const

inline

This function returns the value of the discoverable double property minY : "the start point of the box in the Y direction" .

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

◆ minZ()

PlanarCutsForm::minZ ( ) const

inline

This function returns the value of the discoverable double property minZ : "the start point of the box in the Z direction" .

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

◆ numPixelsX()

PlanarCutsForm::numPixelsX ( ) const

inline

This function returns the value of the discoverable integer property numPixelsX : "the number of pixels in the x direction" .

The minimum value for this property is "1" .

The maximum value for this property is "10000" .

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

◆ numPixelsY()

PlanarCutsForm::numPixelsY ( ) const

inline

This function returns the value of the discoverable integer property numPixelsY : "the number of pixels in the y direction" .

The minimum value for this property is "1" .

The maximum value for this property is "10000" .

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

◆ numPixelsZ()

PlanarCutsForm::numPixelsZ ( ) const

inline

This function returns the value of the discoverable integer property numPixelsZ : "the number of pixels in the z direction" .

The minimum value for this property is "1" .

The maximum value for this property is "10000" .

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

◆ positionX()

PlanarCutsForm::positionX ( ) const

inline

This function returns the value of the discoverable double property positionX : "the x position of the cut parallel to the yz plane" .

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

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

◆ positionY()

PlanarCutsForm::positionY ( ) const

inline

This function returns the value of the discoverable double property positionY : "the y position of the cut parallel to the xz plane" .

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

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

◆ positionZ()

PlanarCutsForm::positionZ ( ) const

inline

This function returns the value of the discoverable double property positionZ : "the z position of the cut parallel to the xy plane" .

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

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

◆ writePlanarCut()

static void PlanarCutsForm::writePlanarCut	(	const ProbeFormBridge *	bridge,
		bool	xd,
		bool	yd,
		bool	zd,
		const Box &	box,
		double	xp,
		double	yp,
		double	zp,
		int	xn,
		int	yn,
		int	zn
	)

static

This static function is also used by the DefaultCutsForm. It outputs a single FITS file representing a cut through the spatial domain along a plane parallel to the coordinate plane indicated by the boolean "direction" arguments xd, yd, and zd, exactly two of which must be true. The argument box specfies the extent of the domain to be considered, the arguments xp, yp, and zp specify the position of the cuts, and the arguments xn, yn, and zn specify the number of pixels in each direction.

◆ writeQuantity()

void PlanarCutsForm::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:

PlanarCutsForm.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PlanarCutsForm()

Member Function Documentation

◆ maxX()

◆ maxY()

◆ maxZ()

◆ minX()

◆ minY()

◆ minZ()

◆ numPixelsX()

◆ numPixelsY()

◆ numPixelsZ()

◆ positionX()

◆ positionY()

◆ positionZ()

◆ writePlanarCut()

◆ writeQuantity()