Skip to content

Commit adf5189

Browse files
committed
doc: private fields docstring
1 parent 3ccf8a3 commit adf5189

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

heudiconv/dicoms.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -491,8 +491,25 @@ def embed_metadata_from_dicoms(bids, item_dicoms, outname, outname_bids,
491491
os.chdir(cwd)
492492

493493
def parse_private_csa_header(dcm_data, public_attr, private_attr, default=None):
494-
"""Doc"""
495-
# tProtocolName
494+
"""
495+
Parses CSA header in cases where value is not defined publicly
496+
497+
Parameters
498+
----------
499+
dcm_data : pydicom Dataset object
500+
DICOM metadata
501+
public_attr : string
502+
non-private DICOM attribute
503+
private_attr : string
504+
private DICOM attribute
505+
default (optional)
506+
default value if private_attr not found
507+
508+
Returns
509+
-------
510+
val (default: empty string)
511+
private attribute value or default
512+
"""
496513
# TODO: provide mapping to private_attr from public_attr
497514
from nibabel.nicom import csareader
498515
import dcmstack.extract as dsextract

0 commit comments

Comments
 (0)