Subclass of RSLine that takes a length and angle instead of a second point. More...

#include <RegionShapes.h>

Inheritance diagram for RSVector:

Public Member Functions
	RSVector (double x, double y, double length, double angle, casacore::MDirection::Types worldSystem, int arrowLength, bool arrow=true, ArrowType arrowType=FilledDoubleV)
	World Constructor. More...

	RSVector (double x, double y, double length, double angle, int arrowLength, bool arrow=true, ArrowType arrowType=FilledDoubleV)
	Pixel Constructor. More...

	RSVector (const casacore::RecordInterface &properties)
	casacore::Record Constructor. More...

	~RSVector ()
	Destructor. More...

bool	arrow () const
	Returns whether the vector has an arrow at the end or not. More...

casacore::String	type () const
	Overrides RSLine::type. More...

void	getVectorCoordinates (double &x, double &y, double &angle, double &length, int &arrowLength, casacore::String toSystem="") const
	Gets vector-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known. More...

std::vector< double >	coordParameterValues () const
	Overrides RSLine::coordParameterValues. More...

std::vector< double >	coordParameterValues (casacore::String toSystem) const
	Implements RegionShape::coordParameterValues. More...

std::vector< casacore::String >	coordParameterNames () const
	Overrides RSLine::coordParameterNames. More...

std::vector < CoordinateParameterType >	coordParameterTypes () const
	Overrides RSLine::coordParameterPositions. More...

void	setCoordParameters (const std::vector< double > &vals)
	Overrides RSLine::setCoordParameters. More...

void	setCoordParameters (const std::vector< double > &vals, casacore::String valSystem)
	Overrides RSLine::setCoordParameters. More...

std::vector< casacore::String >	optionNames () const
	Overrides RSLine::optionNames. More...

std::vector< OptionType >	optionTypes () const
	Overrides RSLine::optionTypes. More...

std::vector< std::vector < casacore::String > >	optionChoices () const
	Overrides RSLine::optionChoices. More...

std::vector< RSOption >	optionValues () const
	Overrides RSLine::optionValues. More...

void	setOptionValues (const std::vector< RSOption > &options)
	Overrides RSLine::setOptions. More...

Protected Member Functions
void	getShapeSpecificProperties (casacore::Record &properties) const
	Overrides RSLine::getShapeSpecificProperties. More...

Protected Attributes
double	m_length

double	m_angle

Detailed Description

Subclass of RSLine that takes a length and angle instead of a second point.

Definition at line 633 of file RegionShapes.h.

Constructor & Destructor Documentation

RSVector::RSVector	(	double	x,
		double	y,
		double	length,
		double	angle,
		casacore::MDirection::Types	worldSystem,
		int	arrowLength,
		bool	arrow = `true`,
		ArrowType	arrowType = `FilledDoubleV`
	)

World Constructor.

x, y, length, and angle must all be 1) using the same world system as defined by worldSystem, and 2) in unit RegionShape::UNIT. Angle is counterclockwise, and the base is the east vector. arrowLength is in screen pixels. arrow defines whether the second point has an arrow.

RSVector::RSVector	(	double	x,
		double	y,
		double	length,
		double	angle,
		int	arrowLength,
		bool	arrow = `true`,
		ArrowType	arrowType = `FilledDoubleV`
	)

Pixel Constructor.

Angle is counterclockwise. arrowLength is in screen pixels. arrow defines whether the second point has an arrow.

RSVector::RSVector ( const casacore::RecordInterface & properties )

casacore::Record Constructor.

RSVector::~RSVector ( )

Destructor.

Member Function Documentation

bool RSVector::arrow ( ) const

inline

Returns whether the vector has an arrow at the end or not.

Definition at line 656 of file RegionShapes.h.

References casa::p2Arrow().

std::vector<casacore::String> RSVector::coordParameterNames ( ) const

Overrides RSLine::coordParameterNames.

std::vector<CoordinateParameterType> RSVector::coordParameterTypes ( ) const

Overrides RSLine::coordParameterPositions.

std::vector<double> RSVector::coordParameterValues ( ) const

Overrides RSLine::coordParameterValues.

std::vector<double> RSVector::coordParameterValues ( casacore::String toSystem ) const

Implements RegionShape::coordParameterValues.

void RSVector::getShapeSpecificProperties ( casacore::Record & properties ) const

inlineprotected

Overrides RSLine::getShapeSpecificProperties.

Definition at line 711 of file RegionShapes.h.

References casacore::RecordInterface::define().

void RSVector::getVectorCoordinates	(	double &	x,
		double &	y,
		double &	angle,
		double &	length,
		int &	arrowLength,
		casacore::String	toSystem = `""`
	)		const

Gets vector-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known.

If toSystem is empty, no conversion is done; otherwise see the constraints listed in RegionShape::coordParameterValues(casacore::String).

std::vector<std::vector<casacore::String> > RSVector::optionChoices ( ) const

Overrides RSLine::optionChoices.

std::vector<casacore::String> RSVector::optionNames ( ) const

Overrides RSLine::optionNames.

std::vector<OptionType> RSVector::optionTypes ( ) const

Overrides RSLine::optionTypes.

std::vector<RSOption> RSVector::optionValues ( ) const

Overrides RSLine::optionValues.

void RSVector::setCoordParameters ( const std::vector< double > & vals )

Overrides RSLine::setCoordParameters.

void RSVector::setCoordParameters	(	const std::vector< double > &	vals,
		casacore::String	valSystem
	)

Overrides RSLine::setCoordParameters.

void RSVector::setOptionValues ( const std::vector< RSOption > & options )

Overrides RSLine::setOptions.

casacore::String RSVector::type ( ) const

inline

Overrides RSLine::type.

Definition at line 661 of file RegionShapes.h.

Member Data Documentation

double RSVector::m_angle

protected

Definition at line 708 of file RegionShapes.h.

double RSVector::m_length

protected

Definition at line 707 of file RegionShapes.h.

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

casa/code/display/RegionShapes/RegionShapes.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation