morphio::vasculature::Vasculature Class Reference

#include <vasculature.h>

Read API
	Vasculature (const std::string &source)
	Vasculature (Vasculature &&)=default
virtual	~Vasculature ()=default
Vasculature &	operator= (const Vasculature &)=default
Vasculature &	operator= (Vasculature &&)=default
std::vector< Section >	sections () const
Section	section (const uint32_t &id) const
const Points &	points () const noexcept
const std::vector< morphio::floatType > &	diameters () const noexcept
const std::vector< property::SectionType::Type > &	sectionTypes () const noexcept
graph_iterator	begin () const
graph_iterator	end () const

Detailed Description

The entry-point class to access vasculature(blood) data

By design, it is the equivalent of the Morphology class but at the vasculature level. As the Morphology class, it implements a section accessor and a root section accessor returning views on the Properties object for the queried vasculature section.

Constructor & Destructor Documentation

Vasculature()

morphio::vasculature::Vasculature::Vasculature ( const std::string &  source )

explicit

Open the given source to a vasculature file and parse it.

Member Function Documentation

begin()

graph_iterator morphio::vasculature::Vasculature::begin

(

)

const

graph iterator pointing to the begin

diameters()

const std::vector< morphio::floatType > & morphio::vasculature::Vasculature::diameters ( ) const

inlinenoexcept

Return a vector with all diameters from all sections

end()

graph_iterator morphio::vasculature::Vasculature::end

(

)

const

graph iterator pointing to the end

points()

const Points & morphio::vasculature::Vasculature::points ( ) const

inlinenoexcept

Return a vector with all points from all sections

section()

Section morphio::vasculature::Vasculature::section

(

const uint32_t &

id

)

const

Return the Section with the given id.

Exceptions

RawDataError

if the id is out of range

sections()

std::vector<Section> morphio::vasculature::Vasculature::sections

(

)

const

Return a vector containing all section objects.

sectionTypes()

const std::vector< property::SectionType::Type > & morphio::vasculature::Vasculature::sectionTypes ( ) const

inlinenoexcept

Return a vector with the section type of every section