NoPolarizationProfile Class Reference

#include <NoPolarizationProfile.hpp>

Inheritance diagram for NoPolarizationProfile:

Public Member Functions
int	dimension () const override
StokesVector	polarizationForDirection (Direction bfk) const override
virtual int	dimension () 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
Public Member Functions inherited from PolarizationProfileInterface
virtual	~PolarizationProfileInterface ()
virtual StokesVector	polarizationForDirection (Direction bfk) const =0

Protected Member Functions
	NoPolarizationProfile ()
Protected Member Functions inherited from PolarizationProfile
	PolarizationProfile ()
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 ()
Protected Member Functions inherited from PolarizationProfileInterface
	PolarizationProfileInterface ()

Private Types
using	BaseType = PolarizationProfile
using	ItemType = NoPolarizationProfile

Friends
class	ItemRegistry

Detailed Description

The NoPolarizationProfile class describes the polarization profile of a source that emits unpolarized radiation in all directions.

Constructor & Destructor Documentation

NoPolarizationProfile()

NoPolarizationProfile::NoPolarizationProfile ( )

inlineprotected

Default constructor for concrete Item subclass NoPolarizationProfile : "an unpolarized emission profile" .

Member Function Documentation

dimension()

int NoPolarizationProfile::dimension ( ) const

overridevirtual

This function returns the dimension of the polarization profile, which depends on its (lack of) symmetry. The unpolarized emission profile is spherically symmetric, so the function returns 1.

Implements PolarizationProfile.

polarizationForDirection()

StokesVector NoPolarizationProfile::polarizationForDirection ( Direction  bfk ) const

overridevirtual

This function returns the Stokes vector defining the polarization state of the radiation emitted into the given direction $(\theta ,\varphi )$. For the unpolarized emission profile, this function returns a default-constructed StokesVector instance.

Implements PolarizationProfileInterface.

---

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

• NoPolarizationProfile.hpp