Documentation
¶
Index ¶
- Constants
- Variables
- type DataSet
- type Element
- func (e *Element) GetString() (string, error)
- func (e *Element) GetStrings() ([]string, error)
- func (e *Element) GetUInt16() (uint16, error)
- func (e *Element) GetUInt32() (uint32, error)
- func (e *Element) GetUint16s() ([]uint16, error)
- func (e *Element) GetUint32s() ([]uint32, error)
- func (e *Element) MustGetString() string
- func (e *Element) MustGetStrings() []string
- func (e *Element) MustGetUInt16() uint16
- func (e *Element) MustGetUInt32() uint32
- func (e *Element) MustGetUint16s() []uint16
- func (e *Element) MustGetUint32s() []uint32
- func (e *Element) String() string
- type PixelDataInfo
Constants ¶
const ( UnknownGroupName = "Unknown Group" PrivateGroupName = "Private Data" )
Constants
const VLUndefinedLength uint32 = 0xffffffff
Variables ¶
var EndOfData = &Element{Tag: dicomtag.Tag{Group: 0x7fff, Element: 0x7fff}}
EndOfData is an pseudoelement to cause the caller to stop reading the input.
Functions ¶
This section is empty.
Types ¶
type DataSet ¶
type DataSet struct {
// Elements in the file, in order of appearance.
//
// Note: unlike pydicom, Elements also contains meta elements (those
// with Tag.Group==2).
Elements []*Element
}
DataSet represents contents of one DICOM file. TODO(suyashkumar): consider putting this in another package
func (*DataSet) FindElementByName ¶
FindByName finds an element from the dataset given the element name, such as "PatientName".
func (*DataSet) FindElementByTag ¶
FindByTag finds an element from the dataset given its tag, such as Tag{0x0010, 0x0010}.
func (*DataSet) TransferSyntax ¶
type Element ¶
type Element struct {
// Tag is a pair of <group, element>. See tags.go for possible values.
Tag dicomtag.Tag
// List of values in the element. Their types depends on value
// representation (VR) of the Tag; Cf. tag.go.
//
// If Tag==TagPixelData, len(Value)==1, and Value[0] is PixelDataInfo.
// Else if Tag==TagItem, each Value[i] is a *Element.
// a value's Tag can be any (including TagItem, which represents a nested Item)
// Else if VR=="SQ", Value[i] is a *Element, with Tag=TagItem.
// Else if VR=="OW", "OB", then len(Value)==1, and Value[0] is []byte.
// Else if VR=="LT", or "UT", then len(Value)==1, and Value[0] is string
// Else if VR=="DA", then len(Value)==1, and Value[0] is string. Use ParseDate() to parse the date string.
// Else if VR=="US", Value[] is a list of uint16s
// Else if VR=="UL", Value[] is a list of uint32s
// Else if VR=="SS", Value[] is a list of int16s
// Else if VR=="SL", Value[] is a list of int32s
// Else if VR=="FL", Value[] is a list of float32s
// Else if VR=="FD", Value[] is a list of float64s
// Else if VR=="AT", Value[] is a list of Tag's.
// Else, Value[] is a list of strings.
//
// Note: Use GetVRKind() to map VR string to the go representation of
// VR.
Value []interface{} // Value Multiplicity PS 3.5 6.4
// VR defines the encoding of Value[] in two-letter alphabets, e.g.,
// "AE", "UL". See P3.5 6.2. This field MUST be set.
//
// dicom.ReadElement() will fill this field with the VR of the tag,
// either read from input stream (for explicit repl), or from the dicom
// tag table (for implicit decl). This field need not be set in
// WriteElement().
//
// Note: In a conformant DICOM file, the VR value of an element is
// determined by its Tag, so this field is redundant. This field is
// still required because a non-conformant file with with explicitVR
// encoding may have an element with VR that's different from the
// standard's. In such case, this library honors the VR value found in
// the file, and this field stores the VR used for parsing Values[].
VR string
// UndefinedLength is true if, in the DICOM file, the element is encoded
// as having undefined length, and is delimited by end-sequence or
// end-item element. This flag is meaningful only if VR=="SQ" or
// VR=="NA". Feel free to ignore this field if you don't understand what
// this means. It's one of the pointless complexities in the DICOM
// standard.
UndefinedLength bool
}
Element represents a single DICOM element. Use NewElement() to create a element denovo. Avoid creating a struct manually, because setting the VR field is a bit tricky.
func FindByName ¶
FindByName finds an element with the given Element.Name in "elems" If not found, returns an error.
func FindByTag ¶
FindByTag finds an element with the given Element.Tag in "elems" If not found, returns an error. TODO: consider a map lookup table perhaps in DataSet
func MustNewElement ¶
MustNewElement is similar to NewElement, but it crashes the process on any error.
func NewElement ¶
NewElement creates a new Element with the given tag and values. The type of each each value must match the VR (value representation) of the tag (see tag_definition.go).
func (*Element) GetString ¶
GetString gets a string value from an element. It returns an error if the element contains zero or >1 values, or the value is not a string.
func (*Element) GetStrings ¶
GetStrings returns the list of strings stored in the elment. Returns an error if the VR of e.Tag is not a string.
func (*Element) GetUInt16 ¶
GetUInt16 gets a uint16 value from an element. It returns an error if the element contains zero or >1 values, or the value is not a uint16.
func (*Element) GetUInt32 ¶
GetUInt32 gets a uint32 value from an element. It returns an error if the element contains zero or >1 values, or the value is not a uint32.
func (*Element) GetUint16s ¶
GetUint16s returns the list of uint16 values stored in the elment. Returns an error if the VR of e.Tag is not a uint16.
func (*Element) GetUint32s ¶
GetUint32s returns the list of uint32 values stored in the elment. Returns an error if the VR of e.Tag is not a uint32.
func (*Element) MustGetString ¶
MustGetString is similar to GetString(), but panics on error.
TODO(saito): Add other variants of MustGet<type>.
func (*Element) MustGetStrings ¶
MustGetStrings is similar to GetStrings, but crashes the process on error.
func (*Element) MustGetUInt16 ¶
MustGetUInt16 is similar to GetUInt16, but panics on error.
func (*Element) MustGetUInt32 ¶
MustGetUInt32 is similar to GetUInt32, but panics on error.
func (*Element) MustGetUint16s ¶
MustGetUint16s is similar to GetUint16s, but crashes the process on error.
func (*Element) MustGetUint32s ¶
MustGetUint32s is similar to GetUint32s, but crashes the process on error.
type PixelDataInfo ¶
type PixelDataInfo struct {
Offsets []uint32 // BasicOffsetTable
IsEncapsulated bool // is the data encapsulated/jpeg encoded?
Frames []frame.Frame // Frames
}
PixelDataInfo is the Element.Value payload for PixelData element.
func (PixelDataInfo) String ¶
func (data PixelDataInfo) String() string
Source Files