lsst::jointcal::StarList< Star > Class Template Reference

std::lists of Stars. More...

#include <StarList.h>

Inheritance diagram for lsst::jointcal::StarList< Star >:

Public Types
typedef std::shared_ptr< Star >	Element
typedef std::list< Element >::const_iterator	StarCIterator
typedef std::list< Element >::iterator	StarIterator

Public Member Functions
	StarList ()
	: default constructor (empty std::list). More...
virtual	~StarList ()
void	print (std::ostream &out) const
	invokes print(stream) for all Stars in the std::list. More...
void	fluxSort ()
	a model routine to sort the std::list More...
void	cutTail (const int nKeep)
	cuts the end of the std::list More...
void	extractInFrame (StarList< Star > &out, const Frame &frame) const
	copy the part of the std::list which is included in the frame at the end of another std::list More...
void	copyTo (StarList< Star > &copy) const
	clears copy and makes a copy of the std::list to copy More...
void	clearList ()
	Clears the std::list. More...
template<class Operator >
void	applyTransform (const Operator &op)
	enables to apply a geometrical transform if Star is Basestar or derives from it. More...
std::shared_ptr< Star >	pop_front (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	push_back (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	splice (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	crbegin (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	erase (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	emplace_front (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	insert (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	reverse (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	back (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	end (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	remove (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	emplace_back (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	pop_back (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	cbegin (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	front (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	unique (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	size (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	resize (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	push_front (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	rbegin (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	crend (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	assign (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	sort (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	merge (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	empty (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	remove_if (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	cend (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	swap (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	max_size (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	rend (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	get_allocator (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	clear (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	emplace (std::shared_ptr< Star > ... args)
std::shared_ptr< Star >	begin (std::shared_ptr< Star > ... args)

Public Attributes
std::shared_ptr< Star >	elements
	STL member. More...

Detailed Description

template<class Star>
class lsst::jointcal::StarList< Star >

std::lists of Stars.

It is a template class, which means that the Star type remains undefined until a user defines it. The std::list related operations (insertion, sort, traversal) are to be carried out using STL list operations. Most of the Star operations rely on routines to be provided in the Star class, usually user defined. The instanciation of this class for BaseStar (i.e. the replacement of the formal parameter 'Star' by 'BaseStar') is called BaseStarList. Take care: what is stored is pointers on Star's and NOT Star's. This implies that Stars being inserted in the std::list have to be obtained using 'new'.

Definition at line 58 of file StarList.h.

Member Typedef Documentation

Element

template<class Star >

typedef std::shared_ptr<Star> lsst::jointcal::StarList< Star >::Element

Definition at line 60 of file StarList.h.

StarCIterator

template<class Star >

typedef std::list<Element>::const_iterator lsst::jointcal::StarList< Star >::StarCIterator

Definition at line 61 of file StarList.h.

StarIterator

template<class Star >

typedef std::list<Element>::iterator lsst::jointcal::StarList< Star >::StarIterator

Definition at line 62 of file StarList.h.

Constructor & Destructor Documentation

StarList()

template<class Star >

lsst::jointcal::StarList< Star >::StarList ( )

inline

: default constructor (empty std::list).

Definition at line 66 of file StarList.h.

{};

~StarList()

template<class Star >

virtual lsst::jointcal::StarList< Star >::~StarList ( )

inlinevirtual

Definition at line 69 of file StarList.h.

{};

Member Function Documentation

applyTransform()

template<class Star >

template<class Operator >

void lsst::jointcal::StarList< Star >::applyTransform ( const Operator &  op )

inline

enables to apply a geometrical transform if Star is Basestar or derives from it.

could be extended to other type of transformations.

Definition at line 98 of file StarList.h.

                                            {
        for (auto &p : *this) op.transformStar(*(p));
    }

clearList()

template<class Star >

void lsst::jointcal::StarList< Star >::clearList ( )

inline

Clears the std::list.

Definition at line 92 of file StarList.h.

{ cutTail(0); };

copyTo()

template<class Star >

void lsst::jointcal::StarList< Star >::copyTo

(

StarList< Star > &

copy

)

const

clears copy and makes a copy of the std::list to copy

Definition at line 68 of file StarList.cc.

                                                      {
    copy.clearList();
    for (auto const &si : *this) copy.push_back(std::make_shared<Star>(*si));
}

cutTail()

template<class Star >

void lsst::jointcal::StarList< Star >::cutTail

(

const int

nKeep

)

cuts the end of the std::list

Definition at line 48 of file StarList.cc.

                                            {
    int count = 0;
    auto si = this->begin();
    for (; si != this->end() && count < nKeep; ++count, ++si)
        ;
    while (si != this->end()) {
        si = this->erase(si);
    }
}

extractInFrame()

template<class Star >

void lsst::jointcal::StarList< Star >::extractInFrame	(	StarList< Star > &	out,
		const Frame &	frame
	)		const

copy the part of the std::list which is included in the frame at the end of another std::list

Definition at line 59 of file StarList.cc.

                                                                                 {
    for (auto const &star : *this) {
        if (frame.inFrame(*star)) {
            out.push_back(std::make_shared<Star>(*star));
        }
    }
}

fluxSort()

template<class Star >

void lsst::jointcal::StarList< Star >::fluxSort

a model routine to sort the std::list

see decreasingFlux() to see what it is, if you want another sorting criterion)

Definition at line 42 of file StarList.cc.

                              {
    typedef StarList<Star>::Element E;
    this->sort([](const E &e1, const E &e2) { return (e1->getFlux() > e2->getFlux()); });
}

print()

template<class Star >

void lsst::jointcal::StarList< Star >::print ( std::ostream &  out ) const

inline

invokes print(stream) for all Stars in the std::list.

Definition at line 72 of file StarList.h.

                                      {
        for (auto &p : *this) p->print(out);
    }

Member Data Documentation

elements

std::shared_ptr< Star > std::list< std::shared_ptr< Star > >::elements

inherited

STL member.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/include/lsst/jointcal/StarList.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/src/StarList.cc