src/pull/pull.h File Reference

#include <teem/air.h>
#include <teem/biff.h>
#include <teem/ell.h>
#include <teem/nrrd.h>
#include <teem/gage.h>
#include <teem/limn.h>
#include <teem/ten.h>

Include dependency graph for pull.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	pullInfoSpec_t
struct	pullPoint_t
struct	pullBin_t
struct	pullEnergy
struct	pullEnergySpec
struct	pullVolume
struct	pullTask_t
struct	pullContext_t
Defines
#define	PULL_EXPORT   extern
#define	PULL   pullBiffKey
#define	PULL_THREAD_MAXNUM   512
#define	PULL_VOLUME_MAXNUM   4
#define	PULL_POINT_NEIGH_INCR   16
#define	PULL_PHIST   0
#define	PULL_INFO_MAX   17
#define	PULL_STATUS_STUCK_BIT   (1<< 1)
#define	PULL_STATUS_NEW_BIT   (1<< 2)
#define	PULL_STATUS_NIXME_BIT   (1<< 3)
#define	PULL_ENERGY_TYPE_MAX   5
#define	PULL_ENERGY_PARM_NUM   3
Typedefs
typedef struct pullInfoSpec_t	pullInfoSpec
typedef struct pullPoint_t	pullPoint
typedef struct pullBin_t	pullBin
typedef struct pullTask_t	pullTask
typedef struct pullContext_t	pullContext
Enumerations
enum	{   pullInfoUnknown, pullInfoTensor, pullInfoTensorInverse, pullInfoHessian,   pullInfoInside, pullInfoInsideGradient, pullInfoHeight, pullInfoHeightGradient,   pullInfoHeightHessian, pullInfoHeightLaplacian, pullInfoSeedThresh, pullInfoTangent1,   pullInfoTangent2, pullInfoTangentMode, pullInfoIsovalue, pullInfoIsovalueGradient,   pullInfoIsovalueHessian, pullInfoStrength, pullInfoLast }
enum	{   pullPropUnknown, pullPropIdtag, pullPropEnergy, pullPropStepEnergy,   pullPropStepConstr, pullPropStuck, pullPropPosition, pullPropForce,   pullPropNeighDist, pullPropLast }
enum	{   pullStatusUnknown, pullStatusStuck, pullStatusNew, pullStatusNixMe,   pullStatusLast }
enum	{   pullCondUnknown, pullCondOld, pullCondConstraintSatA, pullCondConstraintSatB,   pullCondEnergyTry, pullCondConstraintFail, pullCondEnergyBad, pullCondNew,   pullCondLast }
enum	{   pullEnergyTypeUnknown, pullEnergyTypeSpring, pullEnergyTypeGauss, pullEnergyTypeCotan,   pullEnergyTypeQuartic, pullEnergyTypeZero, pullEnergyTypeLast }
Functions
PULL_EXPORT pullEnergySpec *	pullEnergySpecNew ()
PULL_EXPORT int	pullEnergySpecSet (pullEnergySpec *ensp, const pullEnergy *energy, const double parm[PULL_ENERGY_PARM_NUM])
PULL_EXPORT pullEnergySpec *	pullEnergySpecNix (pullEnergySpec *ensp)
PULL_EXPORT int	pullEnergySpecParse (pullEnergySpec *ensp, const char *str)
PULL_EXPORT gageKind *	pullGageKindParse (const char *str)
PULL_EXPORT pullVolume *	pullVolumeNew ()
PULL_EXPORT pullVolume *	pullVolumeNix (pullVolume *vol)
PULL_EXPORT int	pullVolumeSingleAdd (pullContext *pctx, char *name, const Nrrd *nin, const gageKind *kind, const NrrdKernelSpec *ksp00, const NrrdKernelSpec *ksp11, const NrrdKernelSpec *ksp22)
PULL_EXPORT int	pullVolumeStackAdd (pullContext *pctx, char *name, const Nrrd *const *nin, double *scale, unsigned int ninNum, const gageKind *kind, const NrrdKernelSpec *ksp00, const NrrdKernelSpec *ksp11, const NrrdKernelSpec *ksp22, const NrrdKernelSpec *kspSS)
PULL_EXPORT unsigned int	pullInfoAnswerLen (int info)
PULL_EXPORT pullInfoSpec *	pullInfoSpecNew ()
PULL_EXPORT pullInfoSpec *	pullInfoSpecNix (pullInfoSpec *ispec)
PULL_EXPORT int	pullInfoSpecAdd (pullContext *pctx, pullInfoSpec *ispec, int info, const char *volName, int item)
PULL_EXPORT pullContext *	pullContextNew (void)
PULL_EXPORT pullContext *	pullContextNix (pullContext *pctx)
PULL_EXPORT int	pullOutputGet (Nrrd *nPosOut, Nrrd *nTenOut, pullContext *pctx)
PULL_EXPORT int	pullPositionHistoryGet (limnPolyData *pld, pullContext *pctx)
PULL_EXPORT int	pullPropGet (Nrrd *nprop, int prop, pullContext *pctx)
PULL_EXPORT pullPoint *	pullPointNew (pullContext *pctx)
PULL_EXPORT pullPoint *	pullPointNix (pullPoint *pnt)
PULL_EXPORT int	pullBinsPointAdd (pullContext *pctx, pullPoint *point)
PULL_EXPORT void	pullBinsNeighborSet (pullContext *pctx)
PULL_EXPORT int	pullRebin (pullContext *pctx)
PULL_EXPORT int	pullBinProcess (pullTask *task, unsigned int myBinIdx)
PULL_EXPORT int	pullStart (pullContext *pctx)
PULL_EXPORT int	pullRun (pullContext *pctx)
PULL_EXPORT int	pullFinish (pullContext *pctx)
Variables
PULL_EXPORT int	pullPhistEnabled
PULL_EXPORT const char *	pullBiffKey
PULL_EXPORT airEnum *	pullEnergyType
PULL_EXPORT const pullEnergy *const	pullEnergyUnknown
PULL_EXPORT const pullEnergy *const	pullEnergySpring
PULL_EXPORT const pullEnergy *const	pullEnergyGauss
PULL_EXPORT const pullEnergy *const	pullEnergyCoulomb
PULL_EXPORT const pullEnergy *const	pullEnergyCotan
PULL_EXPORT const pullEnergy *const	pullEnergyZero
PULL_EXPORT const pullEnergy *const	pullEnergyAll [PULL_ENERGY_TYPE_MAX+1]
PULL_EXPORT hestCB *	pullHestEnergySpec
PULL_EXPORT airEnum *const	pullInfo

---

Define Documentation

#define PULL   pullBiffKey

#define PULL_ENERGY_PARM_NUM   3

#define PULL_ENERGY_TYPE_MAX   5

#define PULL_EXPORT   extern

#define PULL_INFO_MAX   17

#define PULL_PHIST   0

#define PULL_POINT_NEIGH_INCR   16

#define PULL_STATUS_NEW_BIT   (1<< 2)

#define PULL_STATUS_NIXME_BIT   (1<< 3)

#define PULL_STATUS_STUCK_BIT   (1<< 1)

#define PULL_THREAD_MAXNUM   512

#define PULL_VOLUME_MAXNUM   4

---

Typedef Documentation

typedef struct pullBin_t pullBin

typedef struct pullContext_t pullContext

typedef struct pullInfoSpec_t pullInfoSpec

typedef struct pullPoint_t pullPoint

typedef struct pullTask_t pullTask

---

Enumeration Type Documentation

anonymous enum

Enumerator:

pullInfoUnknown
pullInfoTensor
pullInfoTensorInverse
pullInfoHessian
pullInfoInside
pullInfoInsideGradient
pullInfoHeight
pullInfoHeightGradient
pullInfoHeightHessian
pullInfoHeightLaplacian
pullInfoSeedThresh
pullInfoTangent1
pullInfoTangent2
pullInfoTangentMode
pullInfoIsovalue
pullInfoIsovalueGradient
pullInfoIsovalueHessian
pullInfoStrength
pullInfoLast

anonymous enum

Enumerator:

pullPropUnknown
pullPropIdtag
pullPropEnergy
pullPropStepEnergy
pullPropStepConstr
pullPropStuck
pullPropPosition
pullPropForce
pullPropNeighDist
pullPropLast

anonymous enum

Enumerator:

pullStatusUnknown
pullStatusStuck
pullStatusNew
pullStatusNixMe
pullStatusLast

anonymous enum

Enumerator:

pullCondUnknown
pullCondOld
pullCondConstraintSatA
pullCondConstraintSatB
pullCondEnergyTry
pullCondConstraintFail
pullCondEnergyBad
pullCondNew
pullCondLast

anonymous enum

Enumerator:

pullEnergyTypeUnknown
pullEnergyTypeSpring
pullEnergyTypeGauss
pullEnergyTypeCotan
pullEnergyTypeQuartic
pullEnergyTypeZero
pullEnergyTypeLast

---

Function Documentation

PULL_EXPORT int pullBinProcess	(	pullTask *	task,
		unsigned int	myBinIdx
	)

PULL_EXPORT void pullBinsNeighborSet

(

pullContext *

pctx

)

PULL_EXPORT int pullBinsPointAdd	(	pullContext *	pctx,
		pullPoint *	point
	)

PULL_EXPORT pullContext* pullContextNew

(

void

)

PULL_EXPORT pullContext* pullContextNix

(

pullContext *

pctx

)

PULL_EXPORT pullEnergySpec* pullEnergySpecNew

(

)

PULL_EXPORT pullEnergySpec* pullEnergySpecNix

(

pullEnergySpec *

ensp

)

PULL_EXPORT int pullEnergySpecParse	(	pullEnergySpec *	ensp,
		const char *	str
	)

PULL_EXPORT int pullEnergySpecSet	(	pullEnergySpec *	ensp,
		const pullEnergy *	energy,
		const double	parm[PULL_ENERGY_PARM_NUM]
	)

PULL_EXPORT int pullFinish

(

pullContext *

pctx

)

PULL_EXPORT gageKind* pullGageKindParse

(

const char *

str

)

PULL_EXPORT unsigned int pullInfoAnswerLen

(

int

info

)

PULL_EXPORT int pullInfoSpecAdd	(	pullContext *	pctx,
		pullInfoSpec *	ispec,
		int	info,
		const char *	volName,
		int	item
	)

PULL_EXPORT pullInfoSpec* pullInfoSpecNew

(

)

PULL_EXPORT pullInfoSpec* pullInfoSpecNix

(

pullInfoSpec *

ispec

)

PULL_EXPORT int pullOutputGet	(	Nrrd *	nPosOut,
		Nrrd *	nTenOut,
		pullContext *	pctx
	)

PULL_EXPORT pullPoint* pullPointNew

(

pullContext *

pctx

)

PULL_EXPORT pullPoint* pullPointNix

(

pullPoint *

pnt

)

PULL_EXPORT int pullPositionHistoryGet	(	limnPolyData *	pld,
		pullContext *	pctx
	)

PULL_EXPORT int pullPropGet	(	Nrrd *	nprop,
		int	prop,
		pullContext *	pctx
	)

PULL_EXPORT int pullRebin

(

pullContext *

pctx

)

PULL_EXPORT int pullRun

(

pullContext *

pctx

)

PULL_EXPORT int pullStart

(

pullContext *

pctx

)

PULL_EXPORT pullVolume* pullVolumeNew

(

)

PULL_EXPORT pullVolume* pullVolumeNix

(

pullVolume *

vol

)

PULL_EXPORT int pullVolumeSingleAdd	(	pullContext *	pctx,
		char *	name,
		const Nrrd *	nin,
		const gageKind *	kind,
		const NrrdKernelSpec *	ksp00,
		const NrrdKernelSpec *	ksp11,
		const NrrdKernelSpec *	ksp22
	)

PULL_EXPORT int pullVolumeStackAdd	(	pullContext *	pctx,
		char *	name,
		const Nrrd *const *	nin,
		double *	scale,
		unsigned int	ninNum,
		const gageKind *	kind,
		const NrrdKernelSpec *	ksp00,
		const NrrdKernelSpec *	ksp11,
		const NrrdKernelSpec *	ksp22,
		const NrrdKernelSpec *	kspSS
	)

---

Variable Documentation

PULL_EXPORT const char* pullBiffKey

PULL_EXPORT const pullEnergy* const pullEnergyAll[PULL_ENERGY_TYPE_MAX+1]

PULL_EXPORT const pullEnergy* const pullEnergyCotan

PULL_EXPORT const pullEnergy* const pullEnergyCoulomb

PULL_EXPORT const pullEnergy* const pullEnergyGauss

PULL_EXPORT const pullEnergy* const pullEnergySpring

PULL_EXPORT airEnum* pullEnergyType

PULL_EXPORT const pullEnergy* const pullEnergyUnknown

PULL_EXPORT const pullEnergy* const pullEnergyZero

PULL_EXPORT hestCB* pullHestEnergySpec

PULL_EXPORT airEnum* const pullInfo

PULL_EXPORT int pullPhistEnabled