Libcurvecollection - Revision history

Nathan Malkin: /* Installation */ updating location of curvecollection library

2011-09-09T00:33:32Z

Installation: updating location of curvecollection library

← Older revision		Revision as of 00:33, 9 September 2011
Line 22:		Line 22:

	==Installation==		==Installation==
	The Curve Collection library can be found under <tt>[[$G]]/common/~~libcurvecollection~~/</tt>. To compile and install it, run <code>make all</code>, then <code>make install</code>.		The Curve Collection library can be found under <tt>[[$G]]/common/mri/curvecollection/</tt>. To compile and install it, run <code>make all</code>, then <code>make install</code>.

	To use the library after it has been installed, include the following lines: <br />		To use the library after it has been installed, include the following lines: <br />
	<pre>		<pre>
	#include <~~brain~~/curveCollection.h>		#include <mri/curveCollection.h>
	#include <~~brain~~/curve.h>		#include <mri/curve.h>
	#include <~~brain~~/curveVertex.h>		#include <mri/curveVertex.h>
	</pre> near the top of your file.		</pre> near the top of your file.

Jadrian Miles: User:Nathan Malkin/libcurvecollection moved to Libcurvecollection: It's pretty much ready for primetime.

2011-02-15T18:08:49Z

User:Nathan Malkin/libcurvecollection moved to Libcurvecollection: It's pretty much ready for primetime.

← Older revision	Revision as of 18:08, 15 February 2011
(No difference)

Nathan Malkin: /* CurveCollection */

2010-09-16T21:05:52Z

CurveCollection

← Older revision		Revision as of 21:05, 16 September 2010
Line 333:		Line 333:
	<blockquote>Usage examples: <br />		<blockquote>Usage examples: <br />
	<code>Curve& firstCurve = aCurveCollection[0];<br />Curve& lastCurve = aCurveCollection[aCurveCollection.size() - 1];</code></blockquote>		<code>Curve& firstCurve = aCurveCollection[0];<br />Curve& lastCurve = aCurveCollection[aCurveCollection.size() - 1];</code></blockquote>


	===Setting properties===		===Setting properties===

			====Curve properties====

	<code>void defineCurveProperty(std::string const &, std::vector<double> const &)</code>		<code>void defineCurveProperty(std::string const &, std::vector<double> const &)</code>
Line 345:		Line 348:


	====~~Curve~~ properties====		====Vertex properties====

			<code>void defineVertexProperty(std::string const &, std::vector<std::vector<double> > const &)</code>

			Assigns the given double values to the vertices as properties.

			The properties are assigned in order. That is, the ''k''th vertex in the ''n''th curve in the CurveCollection will get the ''k''th property from the ''n''th vector. If the number of curves and the number of properties given do not match, an <tt>invalid_argument</tt> error is thrown.

	~~====Vertex properties====~~		The curves can be retrieved using the string name they were saved with, or using their Property ID (found using [[#Accessing_properties_and_information_about_them\|CurveCollection::getVertexPropertyID]]) . Note that property name strings are converted to lowercase before being saved.

Nathan Malkin: /* Accessors */

2010-09-16T20:59:45Z

Accessors

← Older revision		Revision as of 20:59, 16 September 2010
Line 331:		Line 331:
	Overloaded random access operators for CurveCollection return a reference to the curve at the specified index.		Overloaded random access operators for CurveCollection return a reference to the curve at the specified index.

	<blockquote>Usage ~~example~~: <code>Curve& firstCurve = aCurveCollection[0];</code></blockquote>		<blockquote>Usage examples: <br />
			<code>Curve& firstCurve = aCurveCollection[0];<br />Curve& lastCurve = aCurveCollection[aCurveCollection.size() - 1];</code></blockquote>

	===Setting properties===		===Setting properties===

Nathan Malkin: /* Accessors */

2010-09-16T20:57:07Z

Accessors

← Older revision		Revision as of 20:57, 16 September 2010
Line 324:		Line 324:

	Returns a reference to the vector of pointers to the curves that comprise this CurveCollection.		Returns a reference to the vector of pointers to the curves that comprise this CurveCollection.


	<code>Curve const & operator[](int) const</code><br />		<code>Curve const & operator[](int) const</code><br />
Line 330:		Line 331:
	Overloaded random access operators for CurveCollection return a reference to the curve at the specified index.		Overloaded random access operators for CurveCollection return a reference to the curve at the specified index.

	<blockquote>Usage example: <code>Curve& ~~firstVertex~~ = aCurveCollection[0];</code></blockquote>		<blockquote>Usage example: <code>Curve& firstCurve = aCurveCollection[0];</code></blockquote>


	===Setting properties===		===Setting properties===

Nathan Malkin: /* CurveCollection */

2010-09-15T15:02:01Z

CurveCollection

← Older revision		Revision as of 15:02, 15 September 2010
Line 317:		Line 317:
	If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.		If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.
	</blockquote>		</blockquote>


	===Accessors===		===Accessors===

			<code>std::vector<Curve*> const & getCurves() const</code>

			Returns a reference to the vector of pointers to the curves that comprise this CurveCollection.

			<code>Curve const & operator[](int) const</code><br />
			<code>Curve & operator[](int)</code>

			Overloaded random access operators for CurveCollection return a reference to the curve at the specified index.

			<blockquote>Usage example: <code>Curve& firstVertex = aCurveCollection[0];</code></blockquote>


	===Setting properties===		===Setting properties===

			<code>void defineCurveProperty(std::string const &, std::vector<double> const &)</code>

			Assigns the given double values to the curves as properties.

			The properties are assigned in order. That is, the ''n''th curve in the CurveCollection will get the ''n''th property from the given vector. If the number of curves and the number of properties given do not match, an <tt>invalid_argument</tt> error is thrown.

			The curves can be retrieved using the string name they were saved with, or using their Property ID (found using [[#Accessing_properties_and_information_about_them\|CurveCollection::getCurvePropertyID]]) . Note that property name strings are converted to lowercase before being saved.


	====Curve properties====		====Curve properties====
Line 337:		Line 358:


	===Clearing ~~property~~===		===Clearing properties===

	====Curve properties====		====Curve properties====
Line 346:		Line 367:

	===I/O functions===		===I/O functions===


			===Other functions===

			<code>int size() const</code>

			Returns the number of curves in this collection.

Nathan Malkin: /* Populating a CurveCollection */

2010-09-13T22:05:15Z

Populating a CurveCollection

← Older revision		Revision as of 22:05, 13 September 2010
Line 313:		Line 313:
	''Special case 1'' <br />		''Special case 1'' <br />
	If the CurveCollection is empty, it will take on the properties (if any) of the given curve. That is, if a curve ''C'' with properties (or vertex properties) is added to a blank CurveCollection, no error is thrown; instead, the CurveCollection "adopts" ''C'''s properties, and the properties of any subsequent curves will be required to match those of ''C''.		If the CurveCollection is empty, it will take on the properties (if any) of the given curve. That is, if a curve ''C'' with properties (or vertex properties) is added to a blank CurveCollection, no error is thrown; instead, the CurveCollection "adopts" ''C'''s properties, and the properties of any subsequent curves will be required to match those of ''C''.
	<br />		<br /><br />
	''Special case 2'' <br />		''Special case 2'' <br />
	If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.		If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.

Nathan Malkin: /* Populating a CurveCollection */

2010-09-13T22:05:02Z

Populating a CurveCollection

← Older revision		Revision as of 22:05, 13 September 2010
Line 313:		Line 313:
	''Special case 1'' <br />		''Special case 1'' <br />
	If the CurveCollection is empty, it will take on the properties (if any) of the given curve. That is, if a curve ''C'' with properties (or vertex properties) is added to a blank CurveCollection, no error is thrown; instead, the CurveCollection "adopts" ''C'''s properties, and the properties of any subsequent curves will be required to match those of ''C''.		If the CurveCollection is empty, it will take on the properties (if any) of the given curve. That is, if a curve ''C'' with properties (or vertex properties) is added to a blank CurveCollection, no error is thrown; instead, the CurveCollection "adopts" ''C'''s properties, and the properties of any subsequent curves will be required to match those of ''C''.
			<br />
	''Special case 2'' <br />		''Special case 2'' <br />
	If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.		If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.
			</blockquote>

	===Accessors===		===Accessors===

Nathan Malkin: /* CurveCollection */

2010-09-13T22:04:32Z

CurveCollection

← Older revision		Revision as of 22:04, 13 September 2010
Line 281:		Line 281:

	The constructor will also do its best to preserve the dimensions and voxel size of the source image. In cases of conflicting dimensions and voxel sizes, the constructor will use smallest voxel size among the candidates and the dimensions that went with that value. Note that these values are only meaningful when writing to (or reading from) TrackVis (''.trk'') files (see note at <tt>CurveCollection::writeTrackVisFile</tt>).		The constructor will also do its best to preserve the dimensions and voxel size of the source image. In cases of conflicting dimensions and voxel sizes, the constructor will use smallest voxel size among the candidates and the dimensions that went with that value. Note that these values are only meaningful when writing to (or reading from) TrackVis (''.trk'') files (see note at <tt>CurveCollection::writeTrackVisFile</tt>).


			<code>CurveCollection(CurveCollection const &)</code>

			Copy constructor. Will produce a curve collection identical to the given one.


			<code>CurveCollection()</code>

			Constructs a blank curve collection, much like you'd expect it to.


			===Destructor===

			<code>~CurveCollection()</code>

			Clears and deletes everything in the CurveCollection.


	===Populating a CurveCollection===		===Populating a CurveCollection===

			<code>void addCurve(Curve const &)</code>

			Appends the given curve to this CurveCollection.

			For this to happen, the properties of the given curve match those of this CurveCollection. Otherwise, a <tt>domain_error</tt> is thrown.

			However, there are two '''exceptions''':

			<blockquote>
			''Special case 1'' <br />
			If the CurveCollection is empty, it will take on the properties (if any) of the given curve. That is, if a curve ''C'' with properties (or vertex properties) is added to a blank CurveCollection, no error is thrown; instead, the CurveCollection "adopts" ''C'''s properties, and the properties of any subsequent curves will be required to match those of ''C''.

			''Special case 2'' <br />
			If a CurveCollection has properties, but the given curve has none, the given curve will be assigned zeros (0.0) in place of all the properties it does not have.

Nathan Malkin: /* CurveCollection */

2010-09-13T21:47:22Z

CurveCollection

← Older revision		Revision as of 21:47, 13 September 2010
Line 263:		Line 263:

	An instance of '''CurveCollection''' holds an arbitrary number of Curve objects and information about the Curve and CurveVertex properties (name/description strings). It also provides functions for the import and export of this data.		An instance of '''CurveCollection''' holds an arbitrary number of Curve objects and information about the Curve and CurveVertex properties (name/description strings). It also provides functions for the import and export of this data.


	===A note on properties===		===A note on properties===
Line 268:		Line 269:

	Why is this the case? For metadata such as curve and vertex properties to be meaningful, there must be some string associated with them: a name (or a description). But storing a string with every data point in a collection is cost-prohibitive (in memory consumed). Since data in most collections shares the same properties, we have chosen to store the property names at the top level — in a CurveCollection. Enforcing this invariant is why all properties must be set at the same time and why a Curve and CurveVertex cannot have properties when they are not in a CurveCollection — without it, there simply isn't a way to look up the properties to access them.		Why is this the case? For metadata such as curve and vertex properties to be meaningful, there must be some string associated with them: a name (or a description). But storing a string with every data point in a collection is cost-prohibitive (in memory consumed). Since data in most collections shares the same properties, we have chosen to store the property names at the top level — in a CurveCollection. Enforcing this invariant is why all properties must be set at the same time and why a Curve and CurveVertex cannot have properties when they are not in a CurveCollection — without it, there simply isn't a way to look up the properties to access them.


	===Constructors===		===Constructors===

			<code>CurveCollection(std::vector<Curve*> const &)</code> <br />
			<code>CurveCollection(std::vector<Curve> const &)</code>

			The constructors take vectors of curves (or pointers to them) as parameters and construct a new CurveCollection using copies of those curves.

			If the curves contain any curve and/or vertex properties, they will be preserved. However, for this to happen, the curves and vertex property names must match (including same order) across all curves. If this is not the case, a <tt>domain_error</tt> is thrown, and the constructor exits.

			The constructor will also do its best to preserve the dimensions and voxel size of the source image. In cases of conflicting dimensions and voxel sizes, the constructor will use smallest voxel size among the candidates and the dimensions that went with that value. Note that these values are only meaningful when writing to (or reading from) TrackVis (''.trk'') files (see note at <tt>CurveCollection::writeTrackVisFile</tt>).