PathMapHeader Class Reference

#include <PathMapHeader.h>

Collaboration diagram for PathMapHeader:

Public Member Functions
	~PathMapHeader ()=default
	PathMapHeader (double max_path_length=10.0, double grid_spacing=1.0, double neighbor_radius=2, double obstacle_threshold=std::numeric_limits< double >::epsilon())
void	update_map_dimensions (int nx=-1, int ny=-1, int nz=-1)
void	set_path_origin (const IMP::algebra::Vector3D &v)
	Sets the origin of the path.
IMP::algebra::Vector3D	get_path_origin () const
	Returns position of the labeling site.
double	get_max_path_length ()
	Get the maximum linker/path length from origin.
double	get_simulation_grid_resolution ()
	Get the simulation grid resolution.
void	set_obstacle_threshold (double obstacle_threshold)
	Set the obstacle threshold.
double	get_obstacle_threshold () const
	Get the obstacle threshold.
void	set_neighbor_radius (double neighbor_radius)
	Set the neighbor radius.
double	get_neighbor_radius () const
	Get the neighbor radius.
int	get_neighbor_box_size () const
	Get the size of the neighbor box.
const IMP::em::DensityHeader *	get_density_header () const
	Returns a read-only pointer to the header of the map.
IMP::em::DensityHeader *	get_density_header_writable ()
	Returns a pointer to the header of the map in a writable version.
IMP::algebra::Vector3D	get_origin () const
	Get origin on the PathMap (the corner of the grid)
double	get_grid_edge_length ()
	Get the edge length of the grid.
void	set_origin (float x, float y, float z)
	Set origin on the PathMap (the corner of the grid)

Protected Attributes
IMP::algebra::Vector3D	path_origin_

Constructor & Destructor Documentation

~PathMapHeader()

PathMapHeader::~PathMapHeader ( )

default

PathMapHeader()

PathMapHeader::PathMapHeader	(	double	max_path_length = 10.0,
		double	grid_spacing = 1.0,
		double	neighbor_radius = 2,
		double	obstacle_threshold = std::numeric_limits< double >::epsilon()
	)

Parameters

max_path_length	maximum length of path (defines also size of grid)
grid_spacing	spacing between grid tiles
neighbor_radius	defines size of box around tile where other voxels are considered a neighbor
obstacle_threshold	voxels with density larger than this threshold value are considered an obstacle.

Member Function Documentation

get_density_header()

const IMP::em::DensityHeader * PathMapHeader::get_density_header ( ) const

inline

Returns a read-only pointer to the header of the map.

get_density_header_writable()

IMP::em::DensityHeader * PathMapHeader::get_density_header_writable ( )

inline

Returns a pointer to the header of the map in a writable version.

get_grid_edge_length()

double PathMapHeader::get_grid_edge_length

(

)

Get the edge length of the grid.

Returns

The edge length of the grid as a double.

get_max_path_length()

double PathMapHeader::get_max_path_length ( )

inline

Get the maximum linker/path length from origin.

Returns

The maximum linker/path length.

get_neighbor_box_size()

int PathMapHeader::get_neighbor_box_size

(

)

const

Get the size of the neighbor box.

Returns

The size of the neighbor box

get_neighbor_radius()

double PathMapHeader::get_neighbor_radius ( ) const

inline

Get the neighbor radius.

Returns

The neighbor radius as a double.

get_obstacle_threshold()

double PathMapHeader::get_obstacle_threshold ( ) const

inline

Get the obstacle threshold.

Returns

The obstacle threshold value

get_origin()

IMP::algebra::Vector3D PathMapHeader::get_origin

(

)

const

Get origin on the PathMap (the corner of the grid)

get_path_origin()

IMP::algebra::Vector3D PathMapHeader::get_path_origin ( ) const

inline

Returns position of the labeling site.

get_simulation_grid_resolution()

double PathMapHeader::get_simulation_grid_resolution

(

)

Get the simulation grid resolution.

Returns

The simulation grid resolution as a double.

set_neighbor_radius()

void PathMapHeader::set_neighbor_radius

(

double

neighbor_radius

)

Set the neighbor radius.

Parameters

neighbor_radius

The neighbor radius value

set_obstacle_threshold()

void PathMapHeader::set_obstacle_threshold

(

double

obstacle_threshold

)

Set the obstacle threshold.

Parameters

obstacle_threshold

The obstacle threshold value

set_origin()

void PathMapHeader::set_origin	(	float	x,
		float	y,
		float	z
	)

Set origin on the PathMap (the corner of the grid)

set_path_origin()

void PathMapHeader::set_path_origin

(

const IMP::algebra::Vector3D &

v

)

Sets the origin of the path.

Parameters

v	The origin vector.

update_map_dimensions()

void PathMapHeader::update_map_dimensions	(	int	nx = -1,
		int	ny = -1,
		int	nz = -1
	)

Update the dimensions of the AV to be (nnx,nny,nnz) The origin of the map does not change. If not values are provided used linker length & radius to update.

Parameters

[in]	nnx	the new number of voxels on the X axis
[in]	nny	the new number of voxels on the Y axis
[in]	nnz	the new number of voxels on the Z axis

Member Data Documentation

path_origin_

IMP::algebra::Vector3D PathMapHeader::path_origin_

protected

---

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

• /Users/tpeulen/dev/imp.bff/include/PathMapHeader.h