forked from malaterre/GDCM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocstrings.i
15775 lines (9694 loc) · 510 KB
/
docstrings.i
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File: index.xml
// File: classgdcm_1_1network_1_1AAbortPDU.xml
%feature("docstring") gdcm::network::AAbortPDU "
AAbortPDU.
Table 9-26 A-ABORT PDU FIELDS
C++ includes: gdcmAAbortPDU.h ";
%feature("docstring") gdcm::network::AAbortPDU::AAbortPDU "gdcm::network::AAbortPDU::AAbortPDU() ";
%feature("docstring") gdcm::network::AAbortPDU::IsLastFragment "bool
gdcm::network::AAbortPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AAbortPDU::Print "void
gdcm::network::AAbortPDU::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AAbortPDU::Read "std::istream&
gdcm::network::AAbortPDU::Read(std::istream &is) ";
%feature("docstring") gdcm::network::AAbortPDU::SetReason "void
gdcm::network::AAbortPDU::SetReason(const uint8_t r) ";
%feature("docstring") gdcm::network::AAbortPDU::SetSource "void
gdcm::network::AAbortPDU::SetSource(const uint8_t s) ";
%feature("docstring") gdcm::network::AAbortPDU::Size "size_t
gdcm::network::AAbortPDU::Size() const ";
%feature("docstring") gdcm::network::AAbortPDU::Write "const
std::ostream& gdcm::network::AAbortPDU::Write(std::ostream &os) const
";
// File: classgdcm_1_1network_1_1AAssociateACPDU.xml
%feature("docstring") gdcm::network::AAssociateACPDU "
AAssociateACPDU.
Table 9-17 ASSOCIATE-AC PDU fields
C++ includes: gdcmAAssociateACPDU.h ";
%feature("docstring") gdcm::network::AAssociateACPDU::AAssociateACPDU
"gdcm::network::AAssociateACPDU::AAssociateACPDU() ";
%feature("docstring")
gdcm::network::AAssociateACPDU::AddPresentationContextAC "void
gdcm::network::AAssociateACPDU::AddPresentationContextAC(PresentationContextAC
const &pcac) ";
%feature("docstring")
gdcm::network::AAssociateACPDU::GetNumberOfPresentationContextAC "SizeType
gdcm::network::AAssociateACPDU::GetNumberOfPresentationContextAC()
const ";
%feature("docstring")
gdcm::network::AAssociateACPDU::GetPresentationContextAC "const
PresentationContextAC&
gdcm::network::AAssociateACPDU::GetPresentationContextAC(SizeType i)
";
%feature("docstring")
gdcm::network::AAssociateACPDU::GetUserInformation "const
UserInformation& gdcm::network::AAssociateACPDU::GetUserInformation()
const ";
%feature("docstring") gdcm::network::AAssociateACPDU::InitFromRQ "void gdcm::network::AAssociateACPDU::InitFromRQ(AAssociateRQPDU const
&rqpdu) ";
%feature("docstring") gdcm::network::AAssociateACPDU::IsLastFragment
"bool gdcm::network::AAssociateACPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AAssociateACPDU::Print "void
gdcm::network::AAssociateACPDU::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AAssociateACPDU::Read "std::istream& gdcm::network::AAssociateACPDU::Read(std::istream &is)
";
%feature("docstring") gdcm::network::AAssociateACPDU::Size "SizeType
gdcm::network::AAssociateACPDU::Size() const ";
%feature("docstring") gdcm::network::AAssociateACPDU::Write "const
std::ostream& gdcm::network::AAssociateACPDU::Write(std::ostream &os)
const ";
// File: classgdcm_1_1network_1_1AAssociateRJPDU.xml
%feature("docstring") gdcm::network::AAssociateRJPDU "
AAssociateRJPDU.
Table 9-21 ASSOCIATE-RJ PDU FIELDS
C++ includes: gdcmAAssociateRJPDU.h ";
%feature("docstring") gdcm::network::AAssociateRJPDU::AAssociateRJPDU
"gdcm::network::AAssociateRJPDU::AAssociateRJPDU() ";
%feature("docstring") gdcm::network::AAssociateRJPDU::IsLastFragment
"bool gdcm::network::AAssociateRJPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AAssociateRJPDU::Print "void
gdcm::network::AAssociateRJPDU::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AAssociateRJPDU::Read "std::istream& gdcm::network::AAssociateRJPDU::Read(std::istream &is)
";
%feature("docstring") gdcm::network::AAssociateRJPDU::Size "size_t
gdcm::network::AAssociateRJPDU::Size() const ";
%feature("docstring") gdcm::network::AAssociateRJPDU::Write "const
std::ostream& gdcm::network::AAssociateRJPDU::Write(std::ostream &os)
const ";
// File: classgdcm_1_1network_1_1AAssociateRQPDU.xml
%feature("docstring") gdcm::network::AAssociateRQPDU "
AAssociateRQPDU.
Table 9-11 ASSOCIATE-RQ PDU fields
C++ includes: gdcmAAssociateRQPDU.h ";
%feature("docstring") gdcm::network::AAssociateRQPDU::AAssociateRQPDU
"gdcm::network::AAssociateRQPDU::AAssociateRQPDU() ";
%feature("docstring") gdcm::network::AAssociateRQPDU::AAssociateRQPDU
"gdcm::network::AAssociateRQPDU::AAssociateRQPDU(const
AAssociateRQPDU &pdu) ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::AddPresentationContext "void
gdcm::network::AAssociateRQPDU::AddPresentationContext(PresentationContextRQ
const &pc) ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetCalledAETitle "std::string
gdcm::network::AAssociateRQPDU::GetCalledAETitle() const ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetCallingAETitle "std::string
gdcm::network::AAssociateRQPDU::GetCallingAETitle() const ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetNumberOfPresentationContext "SizeType
gdcm::network::AAssociateRQPDU::GetNumberOfPresentationContext() const
";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetPresentationContext "PresentationContextRQ const&
gdcm::network::AAssociateRQPDU::GetPresentationContext(SizeType i)
const ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetPresentationContextByAbstractSyntax
"const PresentationContextRQ*
gdcm::network::AAssociateRQPDU::GetPresentationContextByAbstractSyntax(AbstractSyntax
const &absyn) const ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetPresentationContextByID "const
PresentationContextRQ*
gdcm::network::AAssociateRQPDU::GetPresentationContextByID(uint8_t i)
const ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetPresentationContexts "PresentationContextArrayType const&
gdcm::network::AAssociateRQPDU::GetPresentationContexts() ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::GetUserInformation "const
UserInformation& gdcm::network::AAssociateRQPDU::GetUserInformation()
const ";
%feature("docstring") gdcm::network::AAssociateRQPDU::IsLastFragment
"bool gdcm::network::AAssociateRQPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AAssociateRQPDU::Print "void
gdcm::network::AAssociateRQPDU::Print(std::ostream &os) const
This function will initialize an AAssociateACPDU from the fields in
the AAssociateRQPDU structure ";
%feature("docstring") gdcm::network::AAssociateRQPDU::Read "std::istream& gdcm::network::AAssociateRQPDU::Read(std::istream &is)
";
%feature("docstring")
gdcm::network::AAssociateRQPDU::SetCalledAETitle "void
gdcm::network::AAssociateRQPDU::SetCalledAETitle(const char
calledaetitle[16])
Set the Called AE Title. ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::SetCallingAETitle "void
gdcm::network::AAssociateRQPDU::SetCallingAETitle(const char
callingaetitle[16])
Set the Calling AE Title. ";
%feature("docstring")
gdcm::network::AAssociateRQPDU::SetUserInformation "void
gdcm::network::AAssociateRQPDU::SetUserInformation(UserInformation
const &ui) ";
%feature("docstring") gdcm::network::AAssociateRQPDU::Size "size_t
gdcm::network::AAssociateRQPDU::Size() const ";
%feature("docstring") gdcm::network::AAssociateRQPDU::Write "const
std::ostream& gdcm::network::AAssociateRQPDU::Write(std::ostream &os)
const ";
// File: classgdcm_1_1AbortEvent.xml
%feature("docstring") gdcm::AbortEvent "C++ includes: gdcmEvent.h ";
// File: classgdcm_1_1network_1_1AbstractSyntax.xml
%feature("docstring") gdcm::network::AbstractSyntax "
AbstractSyntax.
Table 9-14 ABSTRACT SYNTAX SUB-ITEM FIELDS
C++ includes: gdcmAbstractSyntax.h ";
%feature("docstring") gdcm::network::AbstractSyntax::AbstractSyntax "gdcm::network::AbstractSyntax::AbstractSyntax() ";
%feature("docstring") gdcm::network::AbstractSyntax::GetAsDataElement
"DataElement gdcm::network::AbstractSyntax::GetAsDataElement() const
";
%feature("docstring") gdcm::network::AbstractSyntax::GetName "const
char* gdcm::network::AbstractSyntax::GetName() const ";
%feature("docstring") gdcm::network::AbstractSyntax::Print "void
gdcm::network::AbstractSyntax::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AbstractSyntax::Read "std::istream& gdcm::network::AbstractSyntax::Read(std::istream &is) ";
%feature("docstring") gdcm::network::AbstractSyntax::SetName "void
gdcm::network::AbstractSyntax::SetName(const char *name) ";
%feature("docstring") gdcm::network::AbstractSyntax::SetNameFromUID "void gdcm::network::AbstractSyntax::SetNameFromUID(UIDs::TSName
tsname) ";
%feature("docstring") gdcm::network::AbstractSyntax::Size "size_t
gdcm::network::AbstractSyntax::Size() const ";
%feature("docstring") gdcm::network::AbstractSyntax::Write "const
std::ostream& gdcm::network::AbstractSyntax::Write(std::ostream &os)
const ";
// File: classgdcm_1_1AnonymizeEvent.xml
%feature("docstring") gdcm::AnonymizeEvent "
AnonymizeEvent.
Special type of event triggered during the Anonymization process
See: Anonymizer
C++ includes: gdcmAnonymizeEvent.h ";
%feature("docstring") gdcm::AnonymizeEvent::AnonymizeEvent "gdcm::AnonymizeEvent::AnonymizeEvent(Tag const &tag=0) ";
%feature("docstring") gdcm::AnonymizeEvent::AnonymizeEvent "gdcm::AnonymizeEvent::AnonymizeEvent(const Self &s) ";
%feature("docstring") gdcm::AnonymizeEvent::~AnonymizeEvent "virtual
gdcm::AnonymizeEvent::~AnonymizeEvent() ";
%feature("docstring") gdcm::AnonymizeEvent::CheckEvent "virtual bool
gdcm::AnonymizeEvent::CheckEvent(const ::gdcm::Event *e) const ";
%feature("docstring") gdcm::AnonymizeEvent::GetEventName "virtual
const char* gdcm::AnonymizeEvent::GetEventName() const
Return the StringName associated with the event. ";
%feature("docstring") gdcm::AnonymizeEvent::GetTag "Tag const&
gdcm::AnonymizeEvent::GetTag() const ";
%feature("docstring") gdcm::AnonymizeEvent::MakeObject "virtual
::gdcm::Event* gdcm::AnonymizeEvent::MakeObject() const
Create an Event of this type This method work as a Factory for
creating events of each particular type. ";
%feature("docstring") gdcm::AnonymizeEvent::SetTag "void
gdcm::AnonymizeEvent::SetTag(const Tag &t) ";
// File: classgdcm_1_1Anonymizer.xml
%feature("docstring") gdcm::Anonymizer "
Anonymizer.
This class is a multi purpose anonymizer. It can work in 2 mode: Full
(irreversible) anonymizer (aka dumb mode)
reversible de-identifier/re-identifier (aka smart mode). This
implements the Basic Application Level Confidentiality Profile, DICOM
PS 3.15-2009
dumb mode This is a dumb anonymizer implementation. All it allows user
is simple operation such as:
Tag based functions: complete removal of DICOM attribute (Remove)
make a tag empty, ie make it's length 0 (Empty)
replace with another string-based value (Replace)
DataSet based functions: Remove all group length attribute from a
DICOM dataset (Group Length element are deprecated, DICOM 2008)
Remove all private attributes
Remove all retired attributes
All function calls actually execute the user specified request.
Previous implementation were calling a general Anonymize function but
traversing a std::set is O(n) operation, while a simple user specified
request is O(log(n)) operation. So 'm' user interaction is O(m*log(n))
which is < O(n) complexity.
smart mode this mode implements the Basic Application Level
Confidentiality Profile (DICOM PS 3.15-2008) In this case, it is
extremely important to use the same Anonymizer class when anonymizing
a FileSet. Once the Anonymizer is destroyed its memory of known
(already processed) UIDs will be lost. which will make the anonymizer
behaves incorrectly for attributes such as Series UID Study UID where
user want some consistency. When attribute is Type 1 / Type 1C, a
dummy generator will take in the existing value and produce a dummy
value (a sha1 representation). sha1 algorithm is considered to be
cryptographically strong (compared to md5sum) so that we meet the
following two conditions: Produce the same dummy value for the same
input value
do not provide an easy way to retrieve the original value from the
sha1 generated value
This class implement the Subject/Observer pattern trigger the
following event: AnonymizeEvent
IterationEvent
StartEvent
EndEvent
See: CryptographicMessageSyntax
C++ includes: gdcmAnonymizer.h ";
%feature("docstring") gdcm::Anonymizer::Anonymizer "gdcm::Anonymizer::Anonymizer() ";
%feature("docstring") gdcm::Anonymizer::~Anonymizer "gdcm::Anonymizer::~Anonymizer() ";
%feature("docstring")
gdcm::Anonymizer::BasicApplicationLevelConfidentialityProfile "bool
gdcm::Anonymizer::BasicApplicationLevelConfidentialityProfile(bool
deidentify=true)
PS 3.15 / E.1.1 De-Identifier An Application may claim conformance to
the Basic Application Level Confidentiality Profile as a deidentifier
if it protects all Attributes that might be used by unauthorized
entities to identify the patient. NOT THREAD SAFE ";
%feature("docstring") gdcm::Anonymizer::Empty "bool
gdcm::Anonymizer::Empty(Tag const &t)
Make Tag t empty (if not found tag will be created) Warning: does not
handle SQ element ";
%feature("docstring") gdcm::Anonymizer::GetCryptographicMessageSyntax
"const CryptographicMessageSyntax*
gdcm::Anonymizer::GetCryptographicMessageSyntax() const ";
%feature("docstring") gdcm::Anonymizer::GetFile "File&
gdcm::Anonymizer::GetFile() ";
%feature("docstring") gdcm::Anonymizer::Remove "bool
gdcm::Anonymizer::Remove(Tag const &t)
remove a tag (even a SQ can be removed) Return code is false when tag
t cannot be found ";
%feature("docstring") gdcm::Anonymizer::RemoveGroupLength "bool
gdcm::Anonymizer::RemoveGroupLength()
Main function that loop over all elements and remove group length. ";
%feature("docstring") gdcm::Anonymizer::RemovePrivateTags "bool
gdcm::Anonymizer::RemovePrivateTags()
Main function that loop over all elements and remove private tags. ";
%feature("docstring") gdcm::Anonymizer::RemoveRetired "bool
gdcm::Anonymizer::RemoveRetired()
Main function that loop over all elements and remove retired element.
";
%feature("docstring") gdcm::Anonymizer::Replace "bool
gdcm::Anonymizer::Replace(Tag const &t, const char *value)
Replace tag with another value, if tag is not found it will be
created: WARNING: this function can only execute if tag is a VRASCII
";
%feature("docstring") gdcm::Anonymizer::Replace "bool
gdcm::Anonymizer::Replace(Tag const &t, const char *value, VL const
&vl)
when the value contains \\\\0, it is a good idea to specify the
length. This function is required when dealing with VRBINARY tag ";
%feature("docstring") gdcm::Anonymizer::SetCryptographicMessageSyntax
"void
gdcm::Anonymizer::SetCryptographicMessageSyntax(CryptographicMessageSyntax
*cms)
Set/Get CMS key that will be used to encrypt the dataset within
BasicApplicationLevelConfidentialityProfile. ";
%feature("docstring") gdcm::Anonymizer::SetFile "void
gdcm::Anonymizer::SetFile(const File &f)
Set/Get File. ";
// File: classgdcm_1_1AnyEvent.xml
%feature("docstring") gdcm::AnyEvent "C++ includes: gdcmEvent.h ";
// File: classgdcm_1_1network_1_1ApplicationContext.xml
%feature("docstring") gdcm::network::ApplicationContext "
ApplicationContext.
Table 9-12 APPLICATION CONTEXT ITEM FIELDSTodo Looks like Application
Context can only be 64 bytes at max (see Figure 9-1 / PS 3.8 - 2009 )
C++ includes: gdcmApplicationContext.h ";
%feature("docstring")
gdcm::network::ApplicationContext::ApplicationContext "gdcm::network::ApplicationContext::ApplicationContext() ";
%feature("docstring") gdcm::network::ApplicationContext::GetName "const char* gdcm::network::ApplicationContext::GetName() const ";
%feature("docstring") gdcm::network::ApplicationContext::Print "void
gdcm::network::ApplicationContext::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::ApplicationContext::Read "std::istream& gdcm::network::ApplicationContext::Read(std::istream
&is) ";
%feature("docstring") gdcm::network::ApplicationContext::SetName "void gdcm::network::ApplicationContext::SetName(const char *name) ";
%feature("docstring") gdcm::network::ApplicationContext::Size "size_t gdcm::network::ApplicationContext::Size() const ";
%feature("docstring") gdcm::network::ApplicationContext::Write "const std::ostream&
gdcm::network::ApplicationContext::Write(std::ostream &os) const ";
// File: classgdcm_1_1ApplicationEntity.xml
%feature("docstring") gdcm::ApplicationEntity "
ApplicationEntity.
AE Application Entity
A string of characters that identifies an Application Entity with
leading and trailing spaces (20H) being non-significant. A value
consisting solely of spaces shall not be used.
Default Character Repertoire excluding character code 5CH (the
BACKSLASH \\\\ in ISO-IR 6), and control characters LF, FF, CR and
ESC.
16 bytes maximum
C++ includes: gdcmApplicationEntity.h ";
%feature("docstring") gdcm::ApplicationEntity::IsValid "bool
gdcm::ApplicationEntity::IsValid() const ";
%feature("docstring") gdcm::ApplicationEntity::Print "void
gdcm::ApplicationEntity::Print(std::ostream &os) const ";
%feature("docstring") gdcm::ApplicationEntity::SetBlob "void
gdcm::ApplicationEntity::SetBlob(const std::vector< char > &v) ";
%feature("docstring") gdcm::ApplicationEntity::Squeeze "void
gdcm::ApplicationEntity::Squeeze() ";
// File: classgdcm_1_1network_1_1AReleaseRPPDU.xml
%feature("docstring") gdcm::network::AReleaseRPPDU "
AReleaseRPPDU.
Table 9-25 A-RELEASE-RP PDU fields
C++ includes: gdcmAReleaseRPPDU.h ";
%feature("docstring") gdcm::network::AReleaseRPPDU::AReleaseRPPDU "gdcm::network::AReleaseRPPDU::AReleaseRPPDU() ";
%feature("docstring") gdcm::network::AReleaseRPPDU::IsLastFragment "bool gdcm::network::AReleaseRPPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AReleaseRPPDU::Print "void
gdcm::network::AReleaseRPPDU::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AReleaseRPPDU::Read "std::istream& gdcm::network::AReleaseRPPDU::Read(std::istream &is) ";
%feature("docstring") gdcm::network::AReleaseRPPDU::Size "size_t
gdcm::network::AReleaseRPPDU::Size() const ";
%feature("docstring") gdcm::network::AReleaseRPPDU::Write "const
std::ostream& gdcm::network::AReleaseRPPDU::Write(std::ostream &os)
const ";
// File: classgdcm_1_1network_1_1AReleaseRQPDU.xml
%feature("docstring") gdcm::network::AReleaseRQPDU "
AReleaseRQPDU.
Table 9-24 A-RELEASE-RQ PDU FIELDS
C++ includes: gdcmAReleaseRQPDU.h ";
%feature("docstring") gdcm::network::AReleaseRQPDU::AReleaseRQPDU "gdcm::network::AReleaseRQPDU::AReleaseRQPDU() ";
%feature("docstring") gdcm::network::AReleaseRQPDU::IsLastFragment "bool gdcm::network::AReleaseRQPDU::IsLastFragment() const ";
%feature("docstring") gdcm::network::AReleaseRQPDU::Print "void
gdcm::network::AReleaseRQPDU::Print(std::ostream &os) const ";
%feature("docstring") gdcm::network::AReleaseRQPDU::Read "std::istream& gdcm::network::AReleaseRQPDU::Read(std::istream &is) ";
%feature("docstring") gdcm::network::AReleaseRQPDU::Size "size_t
gdcm::network::AReleaseRQPDU::Size() const ";
%feature("docstring") gdcm::network::AReleaseRQPDU::Write "const
std::ostream& gdcm::network::AReleaseRQPDU::Write(std::ostream &os)
const ";
// File: classgdcm_1_1network_1_1ARTIMTimer.xml
%feature("docstring") gdcm::network::ARTIMTimer "
ARTIMTimer.
This file contains the code for the ARTIM timer.
Basically, the ARTIM timer will just get the wall time when it's
started, and then can be queried for the current time, and then can be
stopped (ie, the start time reset).
Because we're trying to do this without threading, we should be able
to 'start' the ARTIM timer by this mechanism, and then when waiting
for a particular response, tight loop that with sleep calls and
determinations of when the ARTIM timer has reached its peak. As such,
this isn't a strict 'timer' in the traditional sense of the word, but
more of a time keeper.
There can be only one ARTIM timer per connection.
C++ includes: gdcmARTIMTimer.h ";
%feature("docstring") gdcm::network::ARTIMTimer::ARTIMTimer "gdcm::network::ARTIMTimer::ARTIMTimer() ";
%feature("docstring") gdcm::network::ARTIMTimer::GetElapsedTime "double gdcm::network::ARTIMTimer::GetElapsedTime() const ";
%feature("docstring") gdcm::network::ARTIMTimer::GetHasExpired "bool
gdcm::network::ARTIMTimer::GetHasExpired() const ";
%feature("docstring") gdcm::network::ARTIMTimer::GetTimeout "double
gdcm::network::ARTIMTimer::GetTimeout() const ";
%feature("docstring") gdcm::network::ARTIMTimer::SetTimeout "void
gdcm::network::ARTIMTimer::SetTimeout(double inTimeout) ";
%feature("docstring") gdcm::network::ARTIMTimer::Start "void
gdcm::network::ARTIMTimer::Start() ";
%feature("docstring") gdcm::network::ARTIMTimer::Stop "void
gdcm::network::ARTIMTimer::Stop() ";
// File: classgdcm_1_1ASN1.xml
%feature("docstring") gdcm::ASN1 "
Class for ASN1.
C++ includes: gdcmASN1.h ";
%feature("docstring") gdcm::ASN1::ASN1 "gdcm::ASN1::ASN1() ";
%feature("docstring") gdcm::ASN1::~ASN1 "gdcm::ASN1::~ASN1() ";
// File: classgdcm_1_1network_1_1AsynchronousOperationsWindowSub.xml
%feature("docstring") gdcm::network::AsynchronousOperationsWindowSub "
AsynchronousOperationsWindowSub.
PS 3.7 Table D.3-7 ASYNCHRONOUS OPERATIONS WINDOW SUB-ITEM FIELDS (A
-ASSOCIATE-RQ)
C++ includes: gdcmAsynchronousOperationsWindowSub.h ";
%feature("docstring")
gdcm::network::AsynchronousOperationsWindowSub::AsynchronousOperationsWindowSub
"gdcm::network::AsynchronousOperationsWindowSub::AsynchronousOperationsWindowSub()
";
%feature("docstring")
gdcm::network::AsynchronousOperationsWindowSub::Print "void
gdcm::network::AsynchronousOperationsWindowSub::Print(std::ostream
&os) const ";
%feature("docstring")
gdcm::network::AsynchronousOperationsWindowSub::Read "std::istream&
gdcm::network::AsynchronousOperationsWindowSub::Read(std::istream &is)
";
%feature("docstring")
gdcm::network::AsynchronousOperationsWindowSub::Size "size_t
gdcm::network::AsynchronousOperationsWindowSub::Size() const ";
%feature("docstring")
gdcm::network::AsynchronousOperationsWindowSub::Write "const
std::ostream&
gdcm::network::AsynchronousOperationsWindowSub::Write(std::ostream
&os) const ";
// File: classgdcm_1_1Attribute.xml
%feature("docstring") gdcm::Attribute "
Attribute class This class use template metaprograming tricks to let
the user know when the template instanciation does not match the
public dictionary.
Typical example that compile is: Attribute<0x0008,0x9007> a =
{\"ORIGINAL\",\"PRIMARY\",\"T1\",\"NONE\"};
Examples that will NOT compile are:
Attribute<0x0018,0x1182, VR::IS, VM::VM1> fd1 = {}; // not enough
parameters Attribute<0x0018,0x1182, VR::IS, VM::VM2> fd2 = {0,1,2}; //
too many initializers Attribute<0x0018,0x1182, VR::IS, VM::VM3> fd3 =
{0,1,2}; // VM3 is not valid Attribute<0x0018,0x1182, VR::UL, VM::VM2>
fd3 = {0,1}; // UL is not valid VR
C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute::GDCM_STATIC_ASSERT "gdcm::Attribute< Group, Element, TVR, TVM
>::GDCM_STATIC_ASSERT(((VR::VRType) TVR &(VR::VRType)(TagToType<
Group, Element >::VRType))) ";
%feature("docstring") gdcm::Attribute::GDCM_STATIC_ASSERT "gdcm::Attribute< Group, Element, TVR, TVM
>::GDCM_STATIC_ASSERT(((VM::VMType) TVM &(VM::VMType)(TagToType<
Group, Element >::VMType))) ";
%feature("docstring") gdcm::Attribute::GDCM_STATIC_ASSERT "gdcm::Attribute< Group, Element, TVR, TVM
>::GDCM_STATIC_ASSERT(((((VR::VRType) TVR &VR::VR_VM1)&&((VM::VMType)
TVM==VM::VM1))||!((VR::VRType) TVR &VR::VR_VM1))) ";
%feature("docstring") gdcm::Attribute::GetAsDataElement "DataElement
gdcm::Attribute< Group, Element, TVR, TVM >::GetAsDataElement() const
";
%feature("docstring") gdcm::Attribute::GetNumberOfValues "unsigned
int gdcm::Attribute< Group, Element, TVR, TVM >::GetNumberOfValues()
const ";
%feature("docstring") gdcm::Attribute::GetValue "ArrayType&
gdcm::Attribute< Group, Element, TVR, TVM >::GetValue(unsigned int
idx=0) ";
%feature("docstring") gdcm::Attribute::GetValue "ArrayType const&
gdcm::Attribute< Group, Element, TVR, TVM >::GetValue(unsigned int
idx=0) const ";
%feature("docstring") gdcm::Attribute::GetValues "const ArrayType*
gdcm::Attribute< Group, Element, TVR, TVM >::GetValues() const ";
%feature("docstring") gdcm::Attribute::Print "void gdcm::Attribute<
Group, Element, TVR, TVM >::Print(std::ostream &os) const ";
%feature("docstring") gdcm::Attribute::Set "void gdcm::Attribute<
Group, Element, TVR, TVM >::Set(DataSet const &ds) ";
%feature("docstring") gdcm::Attribute::SetFromDataElement "void
gdcm::Attribute< Group, Element, TVR, TVM
>::SetFromDataElement(DataElement const &de) ";
%feature("docstring") gdcm::Attribute::SetFromDataSet "void
gdcm::Attribute< Group, Element, TVR, TVM >::SetFromDataSet(DataSet
const &ds) ";
%feature("docstring") gdcm::Attribute::SetValue "void
gdcm::Attribute< Group, Element, TVR, TVM >::SetValue(ArrayType v,
unsigned int idx=0) ";
%feature("docstring") gdcm::Attribute::SetValues "void
gdcm::Attribute< Group, Element, TVR, TVM >::SetValues(const ArrayType
*array, unsigned int numel=VMType) ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM1_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1 >
" C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT(VMToLength< VM::VM1 >::Length==1) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT(((VR::VRType) TVR &(VR::VRType)(TagToType<
Group, Element >::VRType))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT(((VM::VMType) VM::VM1 &(VM::VMType)(TagToType<
Group, Element >::VMType))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GDCM_STATIC_ASSERT(((((VR::VRType) TVR &VR::VR_VM1)&&((VM::VMType)
VM::VM1==VM::VM1))||!((VR::VRType) TVR &VR::VR_VM1))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetAsDataElement " DataElement gdcm::Attribute< Group, Element,
TVR, VM::VM1 >::GetAsDataElement() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetNumberOfValues " unsigned int gdcm::Attribute< Group, Element,
TVR, VM::VM1 >::GetNumberOfValues() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetValue " ArrayType& gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetValue() ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetValue " ArrayType const& gdcm::Attribute< Group, Element, TVR,
VM::VM1 >::GetValue() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::GetValues " const ArrayType* gdcm::Attribute< Group, Element, TVR,
VM::VM1 >::GetValues() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::Print " void gdcm::Attribute< Group, Element, TVR, VM::VM1
>::Print(std::ostream &os) const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::Set " void gdcm::Attribute< Group, Element, TVR, VM::VM1
>::Set(DataSet const &ds) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::SetFromDataElement " void gdcm::Attribute< Group, Element, TVR,
VM::VM1 >::SetFromDataElement(DataElement const &de) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::SetFromDataSet " void gdcm::Attribute< Group, Element, TVR, VM::VM1
>::SetFromDataSet(DataSet const &ds) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1
>::SetValue " void gdcm::Attribute< Group, Element, TVR, VM::VM1
>::SetValue(ArrayType v) ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM1__3_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_3
> " C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_3
>::GetVM " VM gdcm::Attribute< Group, Element, TVR, VM::VM1_3
>::GetVM() const ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM1__8_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_8
> " C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_8
>::GetVM " VM gdcm::Attribute< Group, Element, TVR, VM::VM1_8
>::GetVM() const ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM1__n_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
> " C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Attribute " gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Attribute() ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::~Attribute " gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::~Attribute() ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GDCM_STATIC_ASSERT(((VR::VRType) TVR
&(VR::VRType)(TagToType< Group, Element >::VRType))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GDCM_STATIC_ASSERT((VM::VM1_n &(VM::VMType)(TagToType<
Group, Element >::VMType))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GDCM_STATIC_ASSERT " gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GDCM_STATIC_ASSERT(((((VR::VRType) TVR
&VR::VR_VM1)&&((VM::VMType) TagToType< Group, Element
>::VMType==VM::VM1))||!((VR::VRType) TVR &VR::VR_VM1))) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GetAsDataElement " DataElement gdcm::Attribute< Group, Element,
TVR, VM::VM1_n >::GetAsDataElement() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GetNumberOfValues " unsigned int gdcm::Attribute< Group, Element,
TVR, VM::VM1_n >::GetNumberOfValues() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GetValue " ArrayType& gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GetValue(unsigned int idx=0) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GetValue " ArrayType const& gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GetValue(unsigned int idx=0) const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::GetValues " const ArrayType* gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::GetValues() const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Print " void gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Print(std::ostream &os) const ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Set " void gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::Set(DataSet const &ds) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetFromDataElement " void gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::SetFromDataElement(DataElement const &de) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetFromDataSet " void gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::SetFromDataSet(DataSet const &ds) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetNumberOfValues " void gdcm::Attribute< Group, Element, TVR,
VM::VM1_n >::SetNumberOfValues(unsigned int numel) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValue " void gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValue(unsigned int idx, ArrayType v) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValue " void gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValue(ArrayType v) ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValues " void gdcm::Attribute< Group, Element, TVR, VM::VM1_n
>::SetValues(const ArrayType *array, unsigned int numel, bool
own=false) ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM2__2n_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM2_2n
> " C++ includes: gdcmAttribute.h ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM2__n_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM2_n
> " C++ includes: gdcmAttribute.h ";
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM2_n
>::GetVM " VM gdcm::Attribute< Group, Element, TVR, VM::VM2_n
>::GetVM() const ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM3__3n_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM3_3n
> " C++ includes: gdcmAttribute.h ";
// File: classgdcm_1_1Attribute_3_01Group_00_01Element_00_01TVR_00_01VM_1_1VM3__n_01_4.xml
%feature("docstring") gdcm::Attribute< Group, Element, TVR, VM::VM3_n
> " C++ includes: gdcmAttribute.h ";
// File: classgdcm_1_1AudioCodec.xml
%feature("docstring") gdcm::AudioCodec "
AudioCodec.
C++ includes: gdcmAudioCodec.h ";
%feature("docstring") gdcm::AudioCodec::AudioCodec "gdcm::AudioCodec::AudioCodec() ";
%feature("docstring") gdcm::AudioCodec::~AudioCodec "gdcm::AudioCodec::~AudioCodec() ";
%feature("docstring") gdcm::AudioCodec::CanCode "bool
gdcm::AudioCodec::CanCode(TransferSyntax const &) const
Return whether this coder support this transfer syntax (can code it)
";
%feature("docstring") gdcm::AudioCodec::CanDecode "bool
gdcm::AudioCodec::CanDecode(TransferSyntax const &) const
Return whether this decoder support this transfer syntax (can decode
it) ";
%feature("docstring") gdcm::AudioCodec::Decode "bool
gdcm::AudioCodec::Decode(DataElement const &is, DataElement &os)
Decode. ";
// File: classgdcm_1_1Base64.xml
%feature("docstring") gdcm::Base64 "
Class for Base64.
C++ includes: gdcmBase64.h ";
// File: classgdcm_1_1network_1_1BaseCompositeMessage.xml
%feature("docstring") gdcm::network::BaseCompositeMessage "
BaseCompositeMessage.
The Composite events described in section 3.7-2009 of the DICOM
standard all use their own messages. These messages are constructed
using Presentation Data Values, from section 3.8-2009 of the standard,
and then fill in appropriate values in their datasets.
So, for the five composites: C-ECHO
C-FIND
C-MOVE
C-GET
C-STORE there are a series of messages. However, all of these messages
are obtained as part of a PDataPDU, and all have to be placed there.
Therefore, since they all have shared functionality and construction
tropes, that will be put into a base class. Further, the base class
will be then returned by the factory class, gdcmCompositePDUFactory.
This is an abstract class. It cannot be instantiated on its own.
C++ includes: gdcmBaseCompositeMessage.h ";
%feature("docstring")
gdcm::network::BaseCompositeMessage::~BaseCompositeMessage "virtual
gdcm::network::BaseCompositeMessage::~BaseCompositeMessage() ";
%feature("docstring")
gdcm::network::BaseCompositeMessage::ConstructPDV "virtual
std::vector<PresentationDataValue>
gdcm::network::BaseCompositeMessage::ConstructPDV(const ULConnection
&inConnection, const BaseRootQuery *inRootQuery)=0 ";
// File: classgdcm_1_1network_1_1BaseNormalizedMessage.xml
%feature("docstring") gdcm::network::BaseNormalizedMessage "
BaseNormalizedMessage.
The Normalized events described in section 3.7-2011 of the DICOM
standard all use their own messages. These messages are constructed
using Presentation Data Values, from section 3.8-2011 of the standard,
and then fill in appropriate values in their datasets.
So, for the five normalized: N-ACTION
N-CREATE
N-DELETE
N-EVENT