dicomdispatch.h File Reference

Public types and prototypes for the DICOM UDF dispatch layer. More...

#include "config.h"
#include "ncdispatch.h"
#include "nep.h"

Go to the source code of this file.

Data Structures
struct	NC_DICOM_VAR_INFO
struct	NC_DICOM_FILE_INFO

Macros
#define	NC_FORMATX_NC_DICOM   NC_FORMATX_UDF0
#define	DICOM_MAGIC_LEN   4
#define	DICOM_INIT_OK()   (NC_DICOM_initialize() != NULL)
#define	DICOM_INIT_AND_ASSIGN(ret)

Typedefs
typedef struct NC_DICOM_VAR_INFO	NC_DICOM_VAR_INFO_T
typedef struct NC_DICOM_FILE_INFO	NC_DICOM_FILE_INFO_T

Functions
int	NC_DICOM_open (const char *path, int mode, int basepe, size_t *chunksizehintp, void *parameters, const NC_Dispatch *, int)
int	NC_DICOM_abort (int ncid)
int	NC_DICOM_close (int ncid, void *ignore)
int	NC_DICOM_inq_format (int ncid, int *formatp)
int	NC_DICOM_inq_format_extended (int ncid, int *formatp, int *modep)
int	NC_DICOM_get_vara (int ncid, int varid, const size_t *start, const size_t *count, void *value, nc_type)
NC_Dispatch *	NC_DICOM_initialize (void)
int	NC_DICOM_finalize (void)

Variables
const NC_Dispatch *	DICOM_dispatch_table

Detailed Description

Public types and prototypes for the DICOM UDF dispatch layer.

Author

Edward Hartnett

Date

2026-07-25

Copyright

Intelligent Data Design, Inc. All rights reserved.

Macro Definition Documentation

DICOM_INIT_AND_ASSIGN

#define DICOM_INIT_AND_ASSIGN

(

ret

)

Value:

        do { \
        (ret) = (NC_DICOM_initialize() != NULL) ? NC_NOERR : NC_EINVAL; \
    } while(0)

DICOM_INIT_OK

#define DICOM_INIT_OK

(

)

(NC_DICOM_initialize() != NULL)

DICOM_MAGIC_LEN

#define DICOM_MAGIC_LEN   4

DICOM magic number length (4 bytes: "DICM")

NC_FORMATX_NC_DICOM

#define NC_FORMATX_NC_DICOM   NC_FORMATX_UDF0

DICOM format uses UDF6 slot for dispatch table model field.

Typedef Documentation

NC_DICOM_FILE_INFO_T

typedef struct NC_DICOM_FILE_INFO NC_DICOM_FILE_INFO_T

Per-file DICOM state with libdicom integration.

NC_DICOM_VAR_INFO_T

typedef struct NC_DICOM_VAR_INFO NC_DICOM_VAR_INFO_T

Per-variable DICOM info: frame index (1-based for pixel_data).

Function Documentation

NC_DICOM_abort()

int NC_DICOM_abort ( int  ncid )

extern

NC_DICOM_close()

int NC_DICOM_close ( int  ncid, void *  ignore  )

extern

NC_DICOM_finalize()

int NC_DICOM_finalize ( void  )

extern

NC_DICOM_get_vara()

int NC_DICOM_get_vara ( int  ncid, int  varid, const size_t *  start, const size_t *  count, void *  value, nc_type    )

extern

NC_DICOM_initialize()

NC_Dispatch * NC_DICOM_initialize ( void  )

extern

NC_DICOM_inq_format()

int NC_DICOM_inq_format ( int  ncid, int *  formatp  )

extern

NC_DICOM_inq_format_extended()

int NC_DICOM_inq_format_extended ( int  ncid, int *  formatp, int *  modep  )

extern

NC_DICOM_open()

int NC_DICOM_open ( const char *  path, int  mode, int  basepe, size_t *  chunksizehintp, void *  parameters, const NC_Dispatch *  , int    )

extern

Variable Documentation

DICOM_dispatch_table

const NC_Dispatch* DICOM_dispatch_table

extern