Doxygen Source Code Documentation

Main Page Alphabetical List Data Structures File List Data Fields Globals Search

SUMA_OVERLAYS Struct Reference

#include <SUMA_define.h>


Data Fields
int	LinkedPtrType
int	N_links
char	owner_id [SUMA_IDCODE_LENGTH]
SUMA_Boolean	Show
char *	Name
char *	Label
int *	NodeDef
int	N_NodeDef
int	FullList
float *	ColVec
float	GlobalOpacity
float *	LocalOpacity
int	PlaneOrder
SUMA_Boolean	isBackGrnd
float	DimFact
float	ForceIntRange [2]
SUMA_DSET *	dset_link
char *	cmapname
SUMA_SCALE_TO_MAP_OPT *	OptScl
int	SymIrange

Detailed Description

Structure containing one color overlay

Definition at line 426 of file SUMA_define.h.

Field Documentation

char* SUMA_OVERLAYS::cmapname

name of colormap (must be in SUMAg_CF->scm)

Definition at line 473 of file SUMA_define.h.

Referenced by SUMA_cb_UnmanageWidget(), SUMA_CmapOfPlane(), SUMA_ColorizePlane(), SUMA_CreateOverlayPointer(), SUMA_FreeOverlayPointer(), SUMA_InitializeColPlaneShell(), SUMA_iRGB_to_OverlayPointer(), SUMA_ScaleToMap_Interactive(), SUMA_SetConvexityPlaneDefaults(), and SUMA_SwitchColPlaneCmap().

float* SUMA_OVERLAYS::ColVec

N_NodeDef x 3 vector containing colors of nodes specified in NodeDef, Replaces ColMat, Wed Mar 17 04

Definition at line 451 of file SUMA_define.h.

Referenced by SUMA_ColorizePlane(), SUMA_CreateOverlayPointer(), SUMA_FreeOverlayPointer(), SUMA_ScaleToMap_Interactive(), and SUMA_UpdateNodeLblField().

float SUMA_OVERLAYS::DimFact

a scaling factor applied to the colors in ColVec This is overriden by BrightFact in OptScl which is defined for non-explicitly colored planes

Definition at line 459 of file SUMA_define.h.

Referenced by SUMA_ColorizePlane(), SUMA_ColPlane_NewDimFact(), SUMA_CreateOverlayPointer(), SUMA_InitializeColPlaneShell(), and SUMA_iRGB_to_OverlayPointer().

SUMA_DSET* SUMA_OVERLAYS::dset_link

A COPY OF THE POINTER to the dataset this plane is attached to. DO NOT FREE THIS POINTER MANUALLY. This is done in the functions for creating and destroying overlay planes

Definition at line 469 of file SUMA_define.h.

Referenced by SUMA_cb_AbsThresh_tb_toggled(), SUMA_cb_SwitchThreshold(), SUMA_ColorizePlane(), SUMA_CreateOverlayPointer(), SUMA_FormSwitchColMenuVector(), SUMA_FreeOverlayPointer(), SUMA_GetNodeOverInd(), SUMA_InitializeColPlaneShell(), SUMA_InitRangeTable(), SUMA_iRGB_to_OverlayPointer(), SUMA_ScaleToMap_Interactive(), and SUMA_UpdateNodeValField().

float SUMA_OVERLAYS::ForceIntRange[2]

Use values here to set OptScl->IntRange instead of the true range of values in the dataset. The idea is to allow particular settings for the autoranging options that are not from the dset's min to max. Usually, this field is not used and both values are set to 0.0

Definition at line 462 of file SUMA_define.h.

Referenced by SUMA_CreateOverlayPointer(), SUMA_InitRangeTable(), and SUMA_SetConvexityPlaneDefaults().

int SUMA_OVERLAYS::FullList

if 1 then it indicates that a full listing of node colors exists. i.e. nodes need not be defined explicitly, in that case NodeDef is stil explicitly defined. I have my reasons.

Definition at line 447 of file SUMA_define.h.

Referenced by SUMA_CreateOverlayPointer(), SUMA_iRGB_to_OverlayPointer(), and SUMA_ScaleToMap_Interactive().

float SUMA_OVERLAYS::GlobalOpacity

Opacity factor between 0 and 1 to apply to all values in ColMat

Definition at line 452 of file SUMA_define.h.

Referenced by SUMA_ColPlane_NewOpacity(), SUMA_CreateOverlayPointer(), SUMA_InitializeColPlaneShell(), SUMA_iRGB_to_OverlayPointer(), SUMA_LoadDsetFile(), SUMA_Overlays_2_GLCOLAR4(), and SUMA_SetConvexityPlaneDefaults().

SUMA_Boolean SUMA_OVERLAYS::isBackGrnd

if YUP then colors overlaid on top of this plane have their brightness modulated by the average intensity of the colors in that plane see the function SUMA_Overlays_2_GLCOLAR4 for details. In other obscure words, if YUP then plane is part of background.

Definition at line 455 of file SUMA_define.h.

Referenced by SUMA_AddNewPlane(), SUMA_AssembleColorPlaneList(), SUMA_CreateOverlayPointer(), SUMA_GetLargestBackroundOrder(), SUMA_GetSmallestForegroundOrder(), SUMA_iRGB_to_OverlayPointer(), SUMA_ListOrderToPlaneOrder(), SUMA_MovePlaneDown(), SUMA_MovePlaneUp(), SUMA_Overlays_2_GLCOLAR4(), SUMA_OverlaysToOrderedList(), and SUMA_SetConvexityPlaneDefaults().