A IifStarcat object is a star catalogue with a set of stars. More...

#include <IifStarcat.h>

Inheritance diagram for Ltcs::IifStarcat:

Collaboration diagram for Ltcs::IifStarcat:

Public Member Functions
	IifStarcat ()
	The catalogue. More...

	IifStarcat (const lbto::SeqPos2 &slist)
	Define the catalogue through a list of stars. More...

	IifStarcat (const Ltcs::SeqIifStar &slist)
	Define the catalogue through a list of stars. More...

	IifStarcat (const std::string &ifnam, const std::string &typ)
	Define the catalogue by reading an LBTO ASCII catalogue. More...

	IifStarcat (const Nice::SeqString &ifnam, const std::string &typ)
	Define the catalogue by merging one or more LBTO ASCII catalogues. More...

	operator lbto::SeqPos2 () const
	Construct the lbto type of vector as used in SetStars2. More...

int	brightest () const
	find brightest in the list More...

void	add (const Ltcs::IifStar &s)
	Add a star to the catalogue. More...

void	add (const lbto::position2 &p)
	Add a star to the catalogue. More...

void	add (const Ltcs::IifStarcat &s)
	Add all stars of another catalogue. Warning: There is no criterion activated that eliminates duplicates. More...

void	rmFaint (const double mag)
	remove the faintest stars from the catalogue More...

void	rm (const size_t idx)
	remove a star at some index in the list. More...

IifStarcat	keepByDist (const double &close, const double &far) const
	Remove stars outside a range of distances to the first in the list. More...

IifStarcat	roi (const double coord1, const double coord2, const double dist) const
	reduce the star set to a neighbourhood (region of interest) of some coordinate. More...

IifStarcat	roi (const IifStar &cntr, const double dist) const
	reduce the star set to a neighbourhood (region of interest) of some coordinate. More...

virtual std::string	toLbtoFmt ()
	Return a sequence of lines equivalent to the small catalogues of LBTO. More...

virtual std::string	toLbtoFmt (const IifStar &cntr, const Nice::Date &t, const double dist)
	Return a sequence of lines equivalent to the small catalogues of LBTO. More...

IifStarcat	propMot () const
	Apply all proper motions. More...

IifStarcat	propMot (const Nice::Date &t) const
	Apply the proper motions. More...

IifStarcat	precess () const
	Correct equatorial coordinates for precession. More...

IifStarcat	precess (const Nice::Date &t) const
	Correct for precession. More...

	IifStarcat ()
	The catalogue. More...

	IifStarcat (const lbto::SeqPos2 &slist)

	IifStarcat (const Ltcs::SeqIifStar &slist)

	IifStarcat (const std::string &ifnam, const std::string &typ)

	IifStarcat (const Nice::SeqString &ifnam, const std::string &typ)

	operator lbto::SeqPos2 () const

int	brightest () const

void	add (const Ltcs::IifStar &s)

void	add (const lbto::position2 &p)

void	add (const Ltcs::IifStarcat &s)

void	rmFaint (const double mag)

void	rm (const size_t idx)

IifStarcat	keepByDist (const double &close, const double &far) const

IifStarcat	roi (const double coord1, const double coord2, const double dist) const

IifStarcat	roi (const IifStar &cntr, const double dist) const

virtual std::string	toLbtoFmt ()

virtual std::string	toLbtoFmt (const IifStar &cntr, const Nice::Date &t, const double dist)

IifStarcat	propMot () const

IifStarcat	propMot (const Nice::Date &t) const

IifStarcat	precess () const

IifStarcat	precess (const Nice::Date &t) const

Protected Member Functions
void	aladin () const
	Show the star system with Aladin of the university of Strasbourgh. This opens a brower window that shows the 3 1/2 arcmin surrounding of the target star. More...

void	cat ()

void	aladin () const

void	cat ()

Static Protected Member Functions
static std::string	mkstemp (const char *tmpnam)
	create a unique temporary empty file . The functionality of mkstemp(3) but resolving the file name on the way. More...

static std::string	mkstemp (const char *tmpnam)

Detailed Description

A IifStarcat object is a star catalogue with a set of stars.

Since: 2017-01-18

Author: R. J. mathar

Constructor & Destructor Documentation

◆ IifStarcat() [1/10]

Ltcs::IifStarcat::IifStarcat ( )

The catalogue.

default ctor. This defines an empty star catalogue

An unsorted list of stars.

Since: 2017-01-18

◆ IifStarcat() [2/10]

Ltcs::IifStarcat::IifStarcat ( const lbto::SeqPos2 & slist )

Define the catalogue through a list of stars.

Parameters

slist The stars in the IIF style that define the (original) set of stars.

Since: 2017-03-19

◆ IifStarcat() [3/10]

Ltcs::IifStarcat::IifStarcat ( const Ltcs::SeqIifStar & slist )

Define the catalogue through a list of stars.

Parameters

slist The stars of the LBTO star catalogue that define the (original) set of stars.

Since: 2017-01-18

◆ IifStarcat() [4/10]

Ltcs::IifStarcat::IifStarcat	(	const std::string &	ifnam,
		const std::string &	typ
	)

Define the catalogue by reading an LBTO ASCII catalogue.

Parameters

ifnam	The File stream of the ASCII file.
typ	Type of the ASCII file. Recognized is the 13-field "lbto" and the 17-field "nomad"

Since: 2017-01-18

◆ IifStarcat() [5/10]

Ltcs::IifStarcat::IifStarcat	(	const Nice::SeqString &	ifnam,
		const std::string &	typ
	)

Define the catalogue by merging one or more LBTO ASCII catalogues.

Parameters

ifnam	The File names of the ASCII files.
typ	Type of the ASCII file. Recognized are "lbto" and "nomad."

Since: 2017-01-18

◆ IifStarcat() [6/10]

Ltcs::IifStarcat::IifStarcat ( )

The catalogue.

An unsorted list of stars.

◆ IifStarcat() [7/10]

Ltcs::IifStarcat::IifStarcat ( const lbto::SeqPos2 & slist )

◆ IifStarcat() [8/10]

Ltcs::IifStarcat::IifStarcat ( const Ltcs::SeqIifStar & slist )

◆ IifStarcat() [9/10]

Ltcs::IifStarcat::IifStarcat	(	const std::string &	ifnam,
		const std::string &	typ
	)

◆ IifStarcat() [10/10]

Ltcs::IifStarcat::IifStarcat	(	const Nice::SeqString &	ifnam,
		const std::string &	typ
	)

Member Function Documentation

◆ add() [1/6]

void Ltcs::IifStarcat::add ( const Ltcs::IifStar & s )

Add a star to the catalogue.

Parameters

s	The star to be incorporated.

Since: 2017-01-18

◆ add() [2/6]

void Ltcs::IifStarcat::add ( const Ltcs::IifStar & s )

◆ add() [3/6]

void Ltcs::IifStarcat::add ( const lbto::position2 & p )

Add a star to the catalogue.

Parameters

p	The star to be incorporated.

Since: 2017-01-18

◆ add() [4/6]

void Ltcs::IifStarcat::add ( const lbto::position2 & p )

◆ add() [5/6]

void Ltcs::IifStarcat::add ( const Ltcs::IifStarcat & s )

Add all stars of another catalogue. Warning: There is no criterion activated that eliminates duplicates.

Parameters

s	The stars to be incorporated.

Since: 2017-01-20

◆ add() [6/6]

void Ltcs::IifStarcat::add ( const Ltcs::IifStarcat & s )

◆ aladin() [1/2]

void Ltcs::IifStarcat::aladin ( ) const

protected

Show the star system with Aladin of the university of Strasbourgh. This opens a brower window that shows the 3 1/2 arcmin surrounding of the target star.

Since: 2017-06-26

◆ aladin() [2/2]

void Ltcs::IifStarcat::aladin ( ) const

protected

◆ brightest() [1/2]

int Ltcs::IifStarcat::brightest ( ) const

◆ brightest() [2/2]

int Ltcs::IifStarcat::brightest ( ) const

find brightest in the list

Returns: the 0-based index of the star with the numerically smallest magnitude. A value of -1 is returned if the list is empty.

Since: 2017-01-18

◆ cat() [1/2]

void Ltcs::IifStarcat::cat ( )

protected

◆ cat() [2/2]

void Ltcs::IifStarcat::cat ( )

protected

◆ keepByDist() [1/2]

Ltcs::IifStarcat Ltcs::IifStarcat::keepByDist	(	const double &	close,
		const double &	far
	)		const

Remove stars outside a range of distances to the first in the list.

Examples: keep all the stars in the region of the HWS up to 1 arcmin: ... = keepByDist(-1.0, 0.000291) or to keep all the stars in the region of the GWS between 1 and 3 arcmin: ... = keepByDist(0.000291, 0.000873)

Parameters

close	The lower distance of the stars in the ring of stars to be kept (radian). Should be set to a negative number if all stars up to some maximum distance are to be kept.
far	The upper distance of the stars in the ring of stars to be kept (radian). Should be set to effectively 3.2 (above pi) to include all stars beyond some distanc.e

Since: 2017-03-01

◆ keepByDist() [2/2]

IifStarcat Ltcs::IifStarcat::keepByDist	(	const double &	close,
		const double &	far
	)		const

◆ mkstemp() [1/2]

std::string Ltcs::IifStarcat::mkstemp ( const char * templ )

staticprotected

create a unique temporary empty file . The functionality of mkstemp(3) but resolving the file name on the way.

Parameters

templ A prefix to faciliate lookup of the use. Note that the XXXXXX marker of mkstemp(3) is not part of the parameter but added locally.

Returns: the name of the new file.

Since: 2017-02-25

◆ mkstemp() [2/2]

static std::string Ltcs::IifStarcat::mkstemp ( const char * tmpnam )

staticprotected

◆ operator lbto::SeqPos2() [1/2]

Ltcs::IifStarcat::operator lbto::SeqPos2 ( ) const

Construct the lbto type of vector as used in SetStars2.

Returns: The set of all stars rendered compatible with the IIF interface.

Since: 2017-04-06

◆ operator lbto::SeqPos2() [2/2]

Ltcs::IifStarcat::operator lbto::SeqPos2 ( ) const

◆ precess() [1/4]

IifStarcat Ltcs::IifStarcat::precess ( ) const

◆ precess() [2/4]

Ltcs::IifStarcat Ltcs::IifStarcat::precess ( ) const

Correct equatorial coordinates for precession.

Returns: a new catalogue with all stars moved from their epoch to the equator of dat.

Since: 2017-03-01

◆ precess() [3/4]

Ltcs::IifStarcat Ltcs::IifStarcat::precess ( const Nice::Date & t ) const

Correct for precession.

Parameters

t	The time when the motion ought to be finished.

Returns: The catalogue in which all stars are moved to the date t.

Since: 2017-03-01

◆ precess() [4/4]

IifStarcat Ltcs::IifStarcat::precess ( const Nice::Date & t ) const

◆ propMot() [1/4]

IifStarcat Ltcs::IifStarcat::propMot ( ) const

◆ propMot() [2/4]

Ltcs::IifStarcat Ltcs::IifStarcat::propMot ( ) const

Apply all proper motions.

Returns: a new catalogue with all stars moved from their epoch to now.

Since: 2017-02-28

◆ propMot() [3/4]

IifStarcat Ltcs::IifStarcat::propMot ( const Nice::Date & t ) const

◆ propMot() [4/4]

Ltcs::IifStarcat Ltcs::IifStarcat::propMot ( const Nice::Date & t ) const

Apply the proper motions.

Parameters

t	The time to which the motion ought to be promoted.

Returns: The catalogue in which all stars are moved to the date t.

Since: 2017-02-28

◆ rm() [1/2]

void Ltcs::IifStarcat::rm ( const size_t idx )

◆ rm() [2/2]

void Ltcs::IifStarcat::rm ( const size_t idx )

remove a star at some index in the list.

Parameters

[in] idx The 0-based index. If the index is outside the range of available stars, nothing happens.

Since: 2017-02-10

◆ rmFaint() [1/2]

void Ltcs::IifStarcat::rmFaint ( const double mag )

◆ rmFaint() [2/2]

void Ltcs::IifStarcat::rmFaint ( const double mag )

remove the faintest stars from the catalogue

Parameters

[in] mag The fainting limit. The limiting magnitude. This means stars with numerical magnitude larger than that will be removed.

Since: 2017-01-20

◆ roi() [1/4]

IifStarcat Ltcs::IifStarcat::roi	(	const double	coord1,
		const double	coord2,
		const double	dist
	)		const

◆ roi() [2/4]

Ltcs::IifStarcat Ltcs::IifStarcat::roi	(	const double	coord1,
		const double	coord2,
		const double	dist
	)		const

reduce the star set to a neighbourhood (region of interest) of some coordinate.

Parameters

coord1	RA of the center of interest (radian)
coord2	DEC of the center of interest (radian)
dist	Maximum distance to the (ra,dec) (radian). Effectively a radius working as a filter criterion on this set.

Returns: A star sub-catalogue where all members farther than the distance from the center are removed.

Since: 2017-01-18

◆ roi() [3/4]

IifStarcat Ltcs::IifStarcat::roi	(	const IifStar &	cntr,
		const double	dist
	)		const

◆ roi() [4/4]

Ltcs::IifStarcat Ltcs::IifStarcat::roi	(	const IifStar &	cntr,
		const double	dist
	)		const

reduce the star set to a neighbourhood (region of interest) of some coordinate.

Parameters

cntr	The star that defines the position of center of the search radius
dist	Maximum distance to the (ra,dec) (radian)

Returns: A star catalogue where all members farther than the distance from the center are removed.

Since: 2017-01-18

◆ toLbtoFmt() [1/4]

std::string Ltcs::IifStarcat::toLbtoFmt ( )

virtual

Return a sequence of lines equivalent to the small catalogues of LBTO.

Returns: A star catalogue where all members farther than the distance from the center are removed. The brightest star is listed first, and the others follow one per line as shown in http://wiki.lbto.org/bin/view/Commissioning/LBTOStarCatalogs

Since: 2017-01-18

◆ toLbtoFmt() [2/4]

virtual std::string Ltcs::IifStarcat::toLbtoFmt ( )

virtual

◆ toLbtoFmt() [3/4]

std::string Ltcs::IifStarcat::toLbtoFmt	(	const IifStar &	cntr,
		const Nice::Date &	t,
		const double	dist
	)

virtual

Return a sequence of lines equivalent to the small catalogues of LBTO.

Parameters

cntr	The star that defines the position of center of the search radius
t	The time to which the coordinate transformations apply.
dist	The maximum distance for keeping stars, relative to cntr, in radians .

Returns: A star catalogue where all members farther than the distance from the center are removed. The brightest star is listed first, and the others follow one per line as shown in http://wiki.lbto.org/bin/view/Commissioning/LBTOStarCatalogs

Since: 2017-01-18

◆ toLbtoFmt() [4/4]

virtual std::string Ltcs::IifStarcat::toLbtoFmt	(	const IifStar &	cntr,
		const Nice::Date &	t,
		const double	dist
	)

virtual

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

/home/nirva/insroot/include/Ltcs/Iif/IifStarcat.h
ln/ltcs/src/iif/Interface/Ltcs/Iif/IifStarcat.cc

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IifStarcat() [1/10]

◆ IifStarcat() [2/10]

◆ IifStarcat() [3/10]

◆ IifStarcat() [4/10]

◆ IifStarcat() [5/10]

◆ IifStarcat() [6/10]

◆ IifStarcat() [7/10]

◆ IifStarcat() [8/10]

◆ IifStarcat() [9/10]

◆ IifStarcat() [10/10]

Member Function Documentation

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ aladin() [1/2]

◆ aladin() [2/2]

◆ brightest() [1/2]

◆ brightest() [2/2]

◆ cat() [1/2]

◆ cat() [2/2]

◆ keepByDist() [1/2]

◆ keepByDist() [2/2]

◆ mkstemp() [1/2]

◆ mkstemp() [2/2]

◆ operator lbto::SeqPos2() [1/2]

◆ operator lbto::SeqPos2() [2/2]

◆ precess() [1/4]

◆ precess() [2/4]

◆ precess() [3/4]

◆ precess() [4/4]

◆ propMot() [1/4]

◆ propMot() [2/4]

◆ propMot() [3/4]

◆ propMot() [4/4]

◆ rm() [1/2]

◆ rm() [2/2]

◆ rmFaint() [1/2]

◆ rmFaint() [2/2]

◆ roi() [1/4]

◆ roi() [2/4]

◆ roi() [3/4]

◆ roi() [4/4]

◆ toLbtoFmt() [1/4]

◆ toLbtoFmt() [2/4]

◆ toLbtoFmt() [3/4]

◆ toLbtoFmt() [4/4]