Skip to content

Commit 44abea9

Browse files
rahulr-NIrahulr-NI
committed
Updating comments and multidimension
1 parent 4e8280a commit 44abea9

File tree

8 files changed

+67
-67
lines changed

8 files changed

+67
-67
lines changed

‎build/helper/metadata_add_all.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,10 @@ def _add_complex_type(parameter):
132132
parameter['complex_type'] = None
133133

134134

135-
def _add_multidimension(parameter):
136-
'''Adds a multidimension parameter to the metadata for 3d arrays'''
137-
if 'multidimension' not in parameter:
138-
parameter['multidimension'] = 0
135+
def _add_array_dimension(parameter):
136+
'''Adds a array_dimension parameter to the metadata for 3d arrays'''
137+
if 'array_dimension' not in parameter:
138+
parameter['array_dimension'] = 0
139139

140140

141141
def _add_numpy_info(parameter, parameters, config):
@@ -463,7 +463,7 @@ def add_all_function_metadata(functions, config):
463463
_add_ctypes_variable_name(p)
464464
_add_ctypes_type(p, config)
465465
_add_complex_type(p)
466-
_add_multidimension(p)
466+
_add_array_dimension(p)
467467
_add_numpy_info(p, functions[f]['parameters'], config)
468468
_add_default_value_name(p)
469469
_add_default_value_name_for_docs(p, config['module_name'])

‎build/templates/_library_interpreter.py.mako‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ def _get_ctypes_pointer_for_buffer(value=None, library_type=None, size=None):
5454
if library_type in (_complextype.NIComplexI16, _complextype.NIComplexNumberF32, _complextype.NIComplexNumber):
5555
complex_dtype = numpy.dtype(library_type)
5656
if value.ndim > 1:
57-
flattened_array = value.ravel().view(complex_dtype)
58-
return flattened_array.ctypes.data_as(ctypes.POINTER(library_type))
57+
# we create a flattened view of the multi-dimensional numpy array
58+
structured_array = value.reshape(-1).view(complex_dtype)
5959
else:
6060
structured_array = value.view(complex_dtype)
61-
return structured_array.ctypes.data_as(ctypes.POINTER(library_type))
61+
return structured_array.ctypes.data_as(ctypes.POINTER(library_type))
6262
else:
6363
return numpy.ctypeslib.as_ctypes(value)
6464
% else:

‎build/templates/session.py/numpy_3d_array_method.py.mako‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
raise TypeError('${parameter['python_name']} must be {0}, is {1}'.format(numpy.ndarray, type(${parameter['python_name']})))
2929
if numpy.isfortran(${parameter['python_name']}) is True:
3030
raise TypeError('${parameter['python_name']} must be in C-order')
31-
if ${parameter['python_name']}.ndim != ${parameter['multidimension']}:
32-
raise TypeError('${parameter['python_name']} must be numpy.ndarray of dimension=${parameter['multidimension']}, is ' + str(${parameter['python_name']}.ndim))
31+
if ${parameter['python_name']}.ndim != ${parameter['array_dimension']}:
32+
raise TypeError('${parameter['python_name']} must be numpy.ndarray of dimension=${parameter['array_dimension']}, is ' + str(${parameter['python_name']}.ndim))
3333
% endfor
3434
% for p in helper.filter_parameters(parameters, helper.ParameterUsageOptions.INTERPRETER_METHOD_CALL):
3535
% if 'python_api_converter_name' in p:

‎build/unit_tests/test_codegen_helper.py‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
'type': 'ViSession',
4343
'numpy': False,
4444
'complex_type': None,
45-
'multidimension': 0,
45+
'array_dimension': 0,
4646
'use_in_python_api': True,
4747
},
4848
{ # 1
@@ -72,7 +72,7 @@
7272
'type': 'ViInt64',
7373
'numpy': False,
7474
'complex_type': None,
75-
'multidimension': 0,
75+
'array_dimension': 0,
7676
'use_in_python_api': True,
7777
},
7878
{ # 2
@@ -101,7 +101,7 @@
101101
'type': 'ViString',
102102
'numpy': False,
103103
'complex_type': None,
104-
'multidimension': 0,
104+
'array_dimension': 0,
105105
'use_in_python_api': True,
106106
},
107107
{ # 3
@@ -131,7 +131,7 @@
131131
'type': 'custom_struct',
132132
'numpy': False,
133133
'complex_type': None,
134-
'multidimension': 0,
134+
'array_dimension': 0,
135135
'use_in_python_api': True,
136136
},
137137
{ # 4
@@ -158,7 +158,7 @@
158158
'type': 'ViInt32',
159159
'numpy': False,
160160
'complex_type': None,
161-
'multidimension': 0,
161+
'array_dimension': 0,
162162
'use_in_python_api': True,
163163
},
164164
{ # 5
@@ -187,7 +187,7 @@
187187
'type': 'ViInt16',
188188
'numpy': False,
189189
'complex_type': None,
190-
'multidimension': 0,
190+
'array_dimension': 0,
191191
'use_in_python_api': True,
192192
},
193193
{ # 6
@@ -217,7 +217,7 @@
217217
'type': 'ViInt16',
218218
'numpy': False,
219219
'complex_type': None,
220-
'multidimension': 0,
220+
'array_dimension': 0,
221221
'use_in_python_api': True,
222222
},
223223
{ # 7
@@ -246,7 +246,7 @@
246246
'type': 'ViInt64',
247247
'numpy': True,
248248
'complex_type': None,
249-
'multidimension': 0,
249+
'array_dimension': 0,
250250
'numpy_type': 'int64',
251251
'numpy_type_library_call': 'numpy.int64',
252252
'use_in_python_api': True,
@@ -269,7 +269,7 @@
269269
'name': 'numberOfElementsPythonCode',
270270
'numpy': False,
271271
'complex_type': None,
272-
'multidimension': 0,
272+
'array_dimension': 0,
273273
'python_name': 'number_of_elements_python_code',
274274
'python_name_with_default': 'number_of_elements_python_code',
275275
'python_name_with_doc_default': 'number_of_elements_python_code',
@@ -296,7 +296,7 @@
296296
'name': 'input',
297297
'numpy': False,
298298
'complex_type': None,
299-
'multidimension': 0,
299+
'array_dimension': 0,
300300
'python_name': 'input',
301301
'python_name_with_default': 'input',
302302
'python_name_with_doc_default': 'input',
@@ -326,7 +326,7 @@
326326
'name': 'inputArray',
327327
'numpy': False,
328328
'complex_type': None,
329-
'multidimension': 0,
329+
'array_dimension': 0,
330330
'python_name': 'input_array',
331331
'python_name_with_default': 'input_array=None',
332332
'python_name_with_doc_default': 'input_array=None',
@@ -353,7 +353,7 @@
353353
'name': 'inputArraySize',
354354
'numpy': False,
355355
'complex_type': None,
356-
'multidimension': 0,
356+
'array_dimension': 0,
357357
'python_name': 'input_array_size',
358358
'python_name_with_default': 'input_array_size',
359359
'python_name_with_doc_default': 'input_array_size',
@@ -380,7 +380,7 @@
380380
'name': 'stringSize',
381381
'numpy': False,
382382
'complex_type': None,
383-
'multidimension': 0,
383+
'array_dimension': 0,
384384
'python_name': 'string_size',
385385
'python_name_with_default': 'string_size',
386386
'python_name_with_doc_default': 'string_size',
@@ -407,7 +407,7 @@
407407
'name': 'aString',
408408
'numpy': False,
409409
'complex_type': None,
410-
'multidimension': 0,
410+
'array_dimension': 0,
411411
'python_name': 'a_string',
412412
'python_name_with_default': 'a_string',
413413
'python_name_with_doc_default': 'a_string',
@@ -435,7 +435,7 @@
435435
'name': 'Timeout',
436436
'numpy': False,
437437
'complex_type': None,
438-
'multidimension': 0,
438+
'array_dimension': 0,
439439
'python_name': 'timeout',
440440
'python_name_with_default': 'timeout=1.0',
441441
'python_name_with_doc_default': 'timeout=1.0',
@@ -465,7 +465,7 @@
465465
'name': 'channelList',
466466
'numpy': False,
467467
'complex_type': None,
468-
'multidimension': 0,
468+
'array_dimension': 0,
469469
'original_type': 'ViChar[]',
470470
'python_name': 'channel_list',
471471
'python_name_with_default': 'channel_list',
@@ -493,7 +493,7 @@
493493
'name': 'aString',
494494
'numpy': False,
495495
'complex_type': None,
496-
'multidimension': 0,
496+
'array_dimension': 0,
497497
'python_name': 'a_string',
498498
'python_name_with_default': 'a_string',
499499
'python_name_with_doc_default': 'a_string',
@@ -527,7 +527,7 @@
527527
'type': 'custom_struct',
528528
'numpy': False,
529529
'complex_type': None,
530-
'multidimension': 0,
530+
'array_dimension': 0,
531531
'use_in_python_api': True,
532532
},
533533
{ # 18
@@ -558,7 +558,7 @@
558558
'type': 'ViInt16',
559559
'numpy': False,
560560
'complex_type': None,
561-
'multidimension': 0,
561+
'array_dimension': 0,
562562
'use_in_python_api': True,
563563
},
564564
{ # 19
@@ -579,7 +579,7 @@
579579
'name': 'aString2',
580580
'numpy': False,
581581
'complex_type': None,
582-
'multidimension': 0,
582+
'array_dimension': 0,
583583
'python_name': 'a_string_2',
584584
'python_name_with_default': 'a_string_2',
585585
'python_name_with_doc_default': 'a_string_2',
@@ -606,7 +606,7 @@
606606
'name': 'aStrin3g',
607607
'numpy': False,
608608
'complex_type': None,
609-
'multidimension': 0,
609+
'array_dimension': 0,
610610
'python_name': 'a_string_3',
611611
'python_name_with_default': 'a_string_3',
612612
'python_name_with_doc_default': 'a_string_3',
@@ -633,7 +633,7 @@
633633
'name': 'aStringTwist',
634634
'numpy': False,
635635
'complex_type': None,
636-
'multidimension': 0,
636+
'array_dimension': 0,
637637
'python_name': 'a_string_twist',
638638
'python_name_with_default': 'a_string_twist',
639639
'python_name_with_doc_default': 'a_string_twist',
@@ -669,7 +669,7 @@
669669
'type': 'ViInt64',
670670
'numpy': False,
671671
'complex_type': None,
672-
'multidimension': 0,
672+
'array_dimension': 0,
673673
'use_in_python_api': True,
674674
},
675675
{ # 23
@@ -690,7 +690,7 @@
690690
'name': 'stringSizeTwist',
691691
'numpy': False,
692692
'complex_type': None,
693-
'multidimension': 0,
693+
'array_dimension': 0,
694694
'python_name': 'string_size_twist',
695695
'python_name_with_default': 'string_size_twist',
696696
'python_name_with_doc_default': 'string_size_twist',
@@ -717,7 +717,7 @@
717717
'name': 'aBufferArray',
718718
'numpy': False,
719719
'complex_type': None,
720-
'multidimension': 0,
720+
'array_dimension': 0,
721721
'python_name': 'a_buffer_array',
722722
'python_name_with_default': 'a_buffer_array',
723723
'python_name_with_doc_default': 'a_buffer_array',
@@ -746,7 +746,7 @@
746746
'name': 'aBufferList',
747747
'numpy': False,
748748
'complex_type': None,
749-
'multidimension': 0,
749+
'array_dimension': 0,
750750
'python_name': 'a_buffer_list',
751751
'python_name_with_default': 'a_buffer_list',
752752
'python_name_with_doc_default': 'a_buffer_list',
@@ -775,7 +775,7 @@
775775
'name': 'aBufferTwistArray',
776776
'numpy': False,
777777
'complex_type': None,
778-
'multidimension': 0,
778+
'array_dimension': 0,
779779
'python_name': 'a_buffer_twist_array',
780780
'python_name_with_default': 'a_buffer_twist_array',
781781
'python_name_with_doc_default': 'a_buffer_twist_array',
@@ -804,7 +804,7 @@
804804
'name': 'aBufferTwistList',
805805
'numpy': False,
806806
'complex_type': None,
807-
'multidimension': 0,
807+
'array_dimension': 0,
808808
'python_name': 'a_buffer_twist_list',
809809
'python_name_with_default': 'a_buffer_twist_list',
810810
'python_name_with_doc_default': 'a_buffer_twist_list',
@@ -836,7 +836,7 @@
836836
'name': 'inputArray2',
837837
'numpy': False,
838838
'complex_type': None,
839-
'multidimension': 0,
839+
'array_dimension': 0,
840840
'python_name': 'input_array_2',
841841
'python_name_with_default': 'input_array_2=None',
842842
'python_name_with_doc_default': 'input_array_2=None',
@@ -866,7 +866,7 @@
866866
'name': 'inputArray2',
867867
'numpy': False,
868868
'complex_type': None,
869-
'multidimension': 0,
869+
'array_dimension': 0,
870870
'python_api_converter_name': 'convert_to_nitclk_session_num_list',
871871
'python_name': 'input_array_2',
872872
'python_name_with_default': 'input_array_2=None',
@@ -897,7 +897,7 @@
897897
'name': 'inputArray3',
898898
'numpy': False,
899899
'complex_type': None,
900-
'multidimension': 0,
900+
'array_dimension': 0,
901901
'python_api_converter_name': 'convert_to_nitclk_session_num_list',
902902
'python_name': 'input_array_3',
903903
'python_name_with_default': 'input_array_3=None',
@@ -928,7 +928,7 @@
928928
'name': 'inputArray4',
929929
'numpy': False,
930930
'complex_type': None,
931-
'multidimension': 0,
931+
'array_dimension': 0,
932932
'python_api_converter_name': 'convert_to_nitclk_session_num_list',
933933
'python_name': 'input_array_4',
934934
'python_name_with_default': 'input_array_4=None',
@@ -959,7 +959,7 @@
959959
'name': 'inputArray4',
960960
'numpy': False,
961961
'complex_type': None,
962-
'multidimension': 0,
962+
'array_dimension': 0,
963963
'python_api_converter_name': 'convert_to_nitclk_session_num_list',
964964
'python_name': 'input_array_4',
965965
'python_name_with_default': 'input_array_4=None',
@@ -987,7 +987,7 @@
987987
'name': 'aStringEnum',
988988
'numpy': False,
989989
'complex_type': None,
990-
'multidimension': 0,
990+
'array_dimension': 0,
991991
'python_name': 'a_string_enum',
992992
'python_name_with_default': 'a_string_enum',
993993
'python_name_with_doc_default': 'a_string_enum',
@@ -1016,7 +1016,7 @@
10161016
'name': 'indices',
10171017
'numpy': False,
10181018
'complex_type': None,
1019-
'multidimension': 0,
1019+
'array_dimension': 0,
10201020
'original_type': 'ViChar[]',
10211021
'python_api_converter_name': 'convert_repeated_capabilities_without_prefix',
10221022
'python_name': 'indices',
@@ -1054,7 +1054,7 @@
10541054
'type': 'ViInt8',
10551055
'numpy': False,
10561056
'complex_type': None,
1057-
'multidimension': 0,
1057+
'array_dimension': 0,
10581058
'use_in_python_api': True,
10591059
},
10601060
]

0 commit comments

Comments
 (0)