/usr/include/teem/mite.h is in libteem-dev 1.11.0~svn6057-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 | /*
Teem: Tools to process and visualize scientific data and images .
Copyright (C) 2013, 2012, 2011, 2010, 2009 University of Chicago
Copyright (C) 2008, 2007, 2006, 2005 Gordon Kindlmann
Copyright (C) 2004, 2003, 2002, 2001, 2000, 1999, 1998 University of Utah
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
(LGPL) as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The terms of redistributing and/or modifying this software also
include exceptions to the LGPL that facilitate static linking.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef MITE_HAS_BEEN_INCLUDED
#define MITE_HAS_BEEN_INCLUDED
#include <teem/air.h>
#include <teem/biff.h>
#include <teem/nrrd.h>
#include <teem/ell.h>
#include <teem/gage.h>
#include <teem/limn.h>
#include <teem/hoover.h>
#include <teem/ten.h>
#if defined(_WIN32) && !defined(__CYGWIN__) && !defined(TEEM_STATIC)
# if defined(TEEM_BUILD) || defined(mite_EXPORTS) || defined(teem_EXPORTS)
# define MITE_EXPORT extern __declspec(dllexport)
# else
# define MITE_EXPORT extern __declspec(dllimport)
# endif
#else /* TEEM_STATIC || UNIX */
# define MITE_EXPORT extern
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define MITE miteBiffKey
/*
******** mite_t
**
** the type used for representing and storing transfer function *range*
** (color, opacity, etc) information is:
** 1: float
** 0: double
*/
#if 0
typedef float mite_t;
# define mite_nt nrrdTypeFloat
# define mite_at airTypeFloat
# define limnVTOQN limnVtoQN_f
# define MITE_T_DOUBLE 0
#else
typedef double mite_t;
# define mite_nt nrrdTypeDouble
# define mite_at airTypeDouble
# define limnVTOQN limnVtoQN_d
# define MITE_T_DOUBLE 1
#endif
enum {
miteRangeUnknown = -1,
miteRangeAlpha, /* 0: "A", opacity */
miteRangeRed, /* 1: "R" */
miteRangeGreen, /* 2: "G" */
miteRangeBlue, /* 3: "B" */
miteRangeEmissivity, /* 4: "E" */
miteRangeKa, /* 5: "a", phong ambient term */
miteRangeKd, /* 6: "d", phong diffuse */
miteRangeKs, /* 7: "s", phong specular */
miteRangeSP, /* 8: "p", phong specular power */
miteRangeLast
};
#define MITE_RANGE_NUM 9
/*
** There are some constraints on how the nrrd as transfer function is
** stored and used:
** 1) all transfer functions are lookup tables: there is no
** interpolation other than nearest neighbor (actually, someday linear
** interpolation may be supported, but that's it)
** 2) regardless of the centerings of the axes of nxtf, the lookup table
** axes will be treated as though they were cell centered (linear
** interpolation will always use node centering)
** 3) the logical dimension of the transfer function is always one less
** ntxf->dim, with axis 0 always for the range of the function, and axes
** 1 and onwards for the domain. For instance, a univariate opacity map
** is 2D, with ntxf->axis[0].size == 1.
**
** So, ntxf->dim-1 is the number of variables in the domain of the transfer
** function, and ntxf->axis[0].size is the number of variables in the range.
*/
/*
******** miteUser struct
**
** all the input parameters for mite specified by the user, as well as
** a mop for cleaning up memory used during rendering. Currently,
** unlike gage, there is no API for setting these- you go in the
** struct and set them yourself.
**
** Mite can currently handle scalar, 3-vector, and (symmetric) tensor
** volumes, one (at most) of each. All these volumes must have the
** same 3-D size, because we're only using one gageContext per thread,
** and the gageContext is what stores the convolution kernel weights
** evaluated per sample.
*/
typedef struct {
Nrrd *nsin, /* scalar volume being rendered */
*nvin, /* 3-vector volume being rendered */
*ntin, /* tensor volume being rendered */
**ntxf, /* array of pointers to nrrds containing transfer
functions, these are never altered (the ntxf
in miteRender, however, is created and altered
based on this ntxf) */
*nout; /* output image container, for five-channel output
RGBAZ. We'll nrrdMaybeAlloc all the image data
and put it in here, but we won't nrrdNuke(nout),
just like we won't nrrdNuke nsin, nvin, ntin, or
any of the ntxf[i] */
double *debug; /* data for verbose pixel (verbUi, verbVi) debug */
airArray *debugArr; /* airArray around debug */
Nrrd *ndebug; /* nrrd re-allocation of debug data */
int debugIdx; /* index into debug data */
int ntxfNum; /* allocated and valid length of ntxf[] */
/* the issue of regular shading, txf-based shading, and surface normals:
phong and lit-tensor shading ("regular shading") methods need to specify
one or more vectors that are used for shading calculations. These will
be parsed from muu->shadeStr into mrr->shadeSpec, which in turn will
determine the pointer values of mtt->shade{Vec,Scl}{0,1}.
ENTIRELY SEPARATE FROM THIS, a "surface normal" can be specified in
muu->normalStr, which (if non-empty), will be parsed into mrr->normalSpec,
which in turn will determine the pointer values of mtt->normal. This
normal is used for the miteVal quantities involving "N".
Both shading and normal specifications can be given, since they are
used in separate computations. If the user wants to do miteVal-based
stuff with the same quantity specified in (say) a phong shading
specification, its up to them to verify that the normalStr and the
shadeStr refer to the same vector.
*/
char shadeStr[AIR_STRLEN_MED], /* how to do shading */
normalStr[AIR_STRLEN_MED]; /* what is the "surface normal" */
/* for each possible element of the txf range, what value should it
start at prior to rendering. Mainly needed to store non-unity values
for the quantities not covered by a transfer function */
mite_t rangeInit[MITE_RANGE_NUM];
double refStep, /* length of "unity" for doing opacity correction */
rayStep, /* distance between sampling planes */
opacMatters, /* minimal significant opacity, currently used to
assign a Z depth (really "Tw") for each rendered
ray */
opacNear1; /* opacity close enough to unity for the sake of
doing early ray termination */
hooverContext *hctx; /* context and input for all hoover-related things,
including camera and image parameters */
double fakeFrom[3], /* if non-NaN, then the "V"-dependent miteVal's will
use this as the nominal eye point, instead of what
is actually being used in the hooverContext */
vectorD[3]; /* some vector to use for something */
/* local initial copies of kernels, later passed to gageKernelSet */
NrrdKernelSpec *ksp[GAGE_KERNEL_MAX+1];
gageShape *shape; /* used just for setting hooverContext->shape */
gageContext *gctx0; /* context and input for all gage-related things,
including all kernels. This is gageContextCopy'd
for multi-threaded use (hence the 0) */
limnLight *lit; /* a struct for all lighting info, although
currently only the ambient and *first* directional
light are used */
int normalSide, /* determines direction of gradient that is used
as normal for shading:
1: the standard way: normal points to lower values
(higher values are more "inside");
0: "two-sided": dot-products are abs()'d
-1: normal points to higher values
(lower values more "inside")
Setting up the values this way allows for idioms
like "if (muu->normalSide) . . .", meaning, if the
lighting is one-sided */
verbUi, verbVi; /* pixel coordinate for which to turn on verbosity */
airArray *umop; /* for things allocated which are used across
multiple renderings */
/* output information from last rendering */
double rendTime, /* rendering time, in seconds */
sampRate; /* rate (KHz) at which samples were rendered */
} miteUser;
struct miteThread_t;
/*
******** miteShadeMethod* enum
**
** the different ways that shading can be done
*/
enum {
miteShadeMethodUnknown,
miteShadeMethodNone, /* 1: no direction shading based on anything
in the miteShadeSpec: just ambient, though
things are still composited with the over
operator, and transfer functions are free
to implement whatever shading they can */
miteShadeMethodPhong, /* 2: what mite has been doing all along */
miteShadeMethodLitTen, /* 3: (tensor-based) lit-tensors */
miteShadeMethodLast
};
/*
******** miteShadeSpec struct
**
** describes how to do shading. With more and more generality in the
** expressions that are evaluated for transfer function application,
** there is less need for this "shading" per se (phong shading can be
** expressed with multiplicative and additive transfer functions).
** But its here for the time being . . .
*/
typedef struct {
int method; /* from miteShadeMethod* enum */
gageItemSpec *vec0, *vec1,
*scl0, *scl1; /* things to use for shading. How these are
interpreted is determined by shadeMethod:
phong: vec0 is used as normal
litten: lit-tensors based on vec0 and vec1,
as weighted by scl0, scl1 */
} miteShadeSpec;
/*
******** miteRender
**
** rendering-parameter-set-specific (but non-thread-specific) state,
** used internally by mite. The primary role here is to store information
** derived from the miteUser, in a form which is more immediately useful
** for rendering.
*/
typedef struct {
Nrrd **ntxf; /* array of transfer function nrrds. The
difference from those in miteUser is that
opacity correction (based on rayStep and
refStep) has been applied to these, and
these have been converted/unquantized to
type mite_t */
int ntxfNum; /* allocated and valid length of ntxf[] */
int sclPvlIdx, vecPvlIdx,
tenPvlIdx; /* indices of the different gageKinds of
volumes in the gageContext's array of
gagePerVolumes. Probably a hack */
miteShadeSpec *shadeSpec; /* information based on muu->shadeStr */
gageItemSpec *normalSpec; /* information based on muu->normalStr */
double time0; /* rendering start time */
gageQuery queryMite; /* record of the miteVal quantities which
we'll need to compute per-sample */
int queryMiteNonzero; /* shortcut miteVal computation if possible */
/* as long as there's no mutex around how the miteThreads are
airMopAdded to the miteUser's mop, these have to be _allocated_ in
mrendRenderBegin, instead of mrendThreadBegin, which still has the
role of initializing them */
struct miteThread_t *tt[HOOVER_THREAD_MAX];
airArray *rmop; /* for things allocated which are rendering
(or rendering parameter) specific and which
are not thread-specific */
} miteRender;
/*
******** miteStageOp* enum
**
** the kinds of things we can do per txf to modify the range
** variables. previously mite only supported separable transfer
** functions (i.e., multiplication only). It is tempting to use all
** the operations available as nrrdBinaryOps, but that would lead to
** goofy ones like Mod and GreaterThan, which either require or create
** integral values which aren't of much use in transfer functions.
** More generality in how opacities and colors are assigned will
** likely be supported by some simple programmability, supported by
** the likes of the funk library, which will be entirely separate from
** the miteStageOp mechanism.
*/
enum {
miteStageOpUnknown, /* 0 */
miteStageOpMin, /* 1 */
miteStageOpMax, /* 2 */
miteStageOpAdd, /* 3 */
miteStageOpMultiply, /* 4 */
miteStageOpLast
};
#define MITE_STAGE_OP_MAX 4
typedef struct {
double *val; /* the txf axis variable, computed either by
gage or by mite. This points into the
answer vector in one of the thread's
pervolumes, or into ansMiteVal in the
miteThread. It can be either a scalar
or a vector */
int size, /* number of entries along this txf axis */
op; /* from miteStageOp* enum. Note that this
operation applies to ALL the range variables
adjusted by this txf (can't add color while
multiplying opacity) */
unsigned int
(*qn)(const double *); /* if non-NULL: callback for doing vector
quantization of vector-valued txf domain
variables */
double min, max; /* quantization range of values which is
covered by this axis of the txf; copied
from corresponding axis of the nrrd */
mite_t *data; /* pointer to txf data. If non-NULL, the
following fields are meaningful */
int rangeIdx[MITE_RANGE_NUM], /* indices into miteThread's range, so that
we know which quantities to update */
rangeNum; /* number of range variables set by the txf
== number of pointers in range[] to use */
char *label; /* pointer into axis label identifying txf
domain variable, NOT COPIED */
} miteStage;
/*
******** miteVal* enum
**
** the quantities not measured by gage (but often reliant on gage-based
** measurements) which can appear in the transfer function domain.
** In many respects, these behave like gage queries, and these are
** associated with a gageKind (miteValGageKind), but it is hardly a
** real, bona fide, gageKind. The answers for these are stored in
** the miteThread, in lieu of a gagePerVolume
*/
enum {
miteValUnknown, /* 0: nobody knows */
miteValXw, /* 1: "Xw", X position, world space (double[1]) */
miteValXi, /* 2: "Xi", X " , index " (double[1]) */
miteValYw, /* 3: "Yw", Y " , world " (double[1]) */
miteValYi, /* 4: "Yi", Y " , index " (double[1]) */
miteValZw, /* 5: "Zw", Z " , world " (double[1]) */
miteValZi, /* 6: "Zi", Z " , index " (double[1]) */
miteValRw, /* 7: "Rw", dist to origin, world " (double[1]) */
miteValRi, /* 8: "Ri", dist to origin, index " (double[1]) */
miteValTw, /* 9: "Tw", ray position (double[1]) */
miteValTi, /* 10: "Ti", ray index (ray sample #) (double[1]) */
miteValView, /* 11: "V", the view vector (double[3]) */
miteValNormal, /* 12: "N", the nominal surface normal, as measured
by a scalar, vector, or tensor kind, and then
determined by the semantics of
muu->normalSide */
miteValNdotV, /* 13: "NdotV", surface normal dotted w/ view vector
(towards eye) (double[1]) */
miteValNdotL, /* 14: "NdotL", surface normal dotted w/ light vector
(towards the light source) (double[1]) */
miteValVrefN, /* 15: "VrefN", view vector reflected across normal
(double[3]) */
miteValGTdotV, /* 16: "GTdotV", normal curvature in view direction,
the contraction of the geometry tensor along
the view vector (double[1]) */
miteValVdefT, /* 17: "defT", view direction, deflected by tensor,
then normalized (double[3]) */
miteValVdefTdotV, /* 18: "VdefTdotV", VdefT dotted back with V, not the
same as the tensor contraction along V,
(double[1]) */
miteValWdotD, /* 19: "WdotD", world space position dotted with
muu->vectorD */
miteValLast
};
#define MITE_VAL_ITEM_MAX 19
/*
******** miteThread
**
** thread-specific state for mite's internal use
*/
typedef struct miteThread_t {
gageContext *gctx; /* per-thread context */
double *ansScl, /* pointer to gageKindScl answer vector */
*nPerp, *geomTens, /* convenience pointers into ansScl */
*ansVec, /* pointer to gageKindVec answer vector */
*ansTen, /* pointer to tenGageKind answer vector */
*ansMiteVal, /* room for all the miteVal answers, which
unlike ans{Scl,Vec,Ten} is allocated by
mite instead of by gage */
**directAnsMiteVal, /* pointers into ansMiteVal */
*_normal, /* pointer into ans{Scl,Vec,Ten} array above,
(NOT ansMiteVal); this will determine the
value of miteValNormal according to the
semantics of muu->normalSide */
*shadeVec0, *shadeVec1,
*shadeScl0, *shadeScl1; /* pointers into the ans* arrays above,
used for shading */
int verbose, /* non-zero if
(ui,vi) = (muu->verbUi,muu->verbVi)
Because of the actions associated with
recording values in muu->ndebug, it is
currently reasonable for verbose to be
non-zero for at most *ONE* pixel: it has
to be one pixel because only one thread
should be creating and storing this per-
pixel information in the miteUser */
skip, /* non-zero if we shouldn't actually do any
work for this pixel */
thrid, /* thread ID */
ui, vi, /* image coords of current ray */
raySample, /* number of samples finished in this ray */
samples; /* number of samples handled so far by
this thread */
miteStage *stage; /* array of stages for txf computation */
int stageNum; /* number of stages == length of stage[] */
mite_t range[MITE_RANGE_NUM], /* rendering variables, which are either
copied from miteUser's rangeInit[], or
over-written by txf evaluation */
rayStep, /* per-ray step (may need to be different for
each ray to enable sampling on planes) */
V[3], /* per-ray view direction */
RR, GG, BB, TT, /* per-ray composited values */
ZZ; /* for storing ray-depth when opacity passed
muu->opacMatters */
airArray *rmop; /* for things allocated which are rendering
(or rendering parameter) specific and which
are thread-specific */
} miteThread;
/* defaultsMite.c */
MITE_EXPORT const int mitePresent;
MITE_EXPORT const char *miteBiffKey;
MITE_EXPORT double miteDefRefStep;
MITE_EXPORT int miteDefRenorm;
MITE_EXPORT int miteDefNormalSide;
MITE_EXPORT double miteDefOpacNear1;
MITE_EXPORT double miteDefOpacMatters;
/* kindnot.c */
MITE_EXPORT const airEnum *const miteVal;
MITE_EXPORT gageKind *miteValGageKind;
/* txf.c */
MITE_EXPORT const airEnum *const miteStageOp;
MITE_EXPORT char miteRangeChar[MITE_RANGE_NUM+1];
MITE_EXPORT int miteVariableParse(gageItemSpec *isp, const char *label);
MITE_EXPORT void miteVariablePrint(char *buff, const gageItemSpec *isp);
MITE_EXPORT int miteNtxfCheck(const Nrrd *ntxf);
MITE_EXPORT void miteQueryAdd(gageQuery queryScl, gageQuery queryVec,
gageQuery queryTen, gageQuery queryMite,
gageItemSpec *isp);
/* user.c */
MITE_EXPORT miteUser *miteUserNew(void);
MITE_EXPORT miteUser *miteUserNix(miteUser *muu);
/* shade.c */
MITE_EXPORT miteShadeSpec *miteShadeSpecNew(void);
MITE_EXPORT miteShadeSpec *miteShadeSpecNix(miteShadeSpec *);
MITE_EXPORT int miteShadeSpecParse(miteShadeSpec *shpec, char *shadeStr);
MITE_EXPORT void miteShadeSpecPrint(char *buff, const miteShadeSpec *shpec);
MITE_EXPORT void miteShadeSpecQueryAdd(gageQuery queryScl, gageQuery queryVec,
gageQuery queryTen, gageQuery queryMite,
miteShadeSpec *shpec);
/* renderMite.c */
MITE_EXPORT int miteRenderBegin(miteRender **mrrP, miteUser *muu);
MITE_EXPORT int miteRenderEnd(miteRender *mrr, miteUser *muu);
/* thread.c */
MITE_EXPORT miteThread *miteThreadNew(void);
MITE_EXPORT miteThread *miteThreadNix(miteThread *mtt);
MITE_EXPORT int miteThreadBegin(miteThread **mttP, miteRender *mrr,
miteUser *muu, int whichThread);
MITE_EXPORT int miteThreadEnd(miteThread *mtt, miteRender *mrr, miteUser *muu);
/* ray.c */
MITE_EXPORT int miteRayBegin(miteThread *mtt, miteRender *mrr, miteUser *muu,
int uIndex, int vIndex,
double rayLen,
double rayStartWorld[3], double rayStartIndex[3],
double rayDirWorld[3], double rayDirIndex[3]);
MITE_EXPORT double miteSample(miteThread *mtt, miteRender *mrr, miteUser *muu,
int num, double rayT, int inside,
double samplePosWorld[3],
double samplePosIndex[3]);
MITE_EXPORT int miteRayEnd(miteThread *mtt, miteRender *mrr,
miteUser *muu);
#ifdef __cplusplus
}
#endif
#endif /* MITE_HAS_BEEN_INCLUDED */
|