nifgen.Session¶

class nifgen.Session¶

An NI-FGEN session to a National Instruments Signal Generator.

Properties

Property	Datatype
`all_marker_events_latched_status`	int
`all_marker_events_live_status`	int
`analog_data_mask`	int
`analog_filter_enabled`	bool
`analog_path`	`AnalogPath`
`analog_static_value`	int
`arb_gain`	float
`arb_marker_position`	int
`arb_offset`	float
`arb_repeat_count`	int
`arb_sample_rate`	float
`arb_sequence_handle`	int
`arb_waveform_handle`	int
`aux_power_enabled`	bool
`bus_type`	`BusType`
`cache`	bool
`channel_delay`	float
`clock_mode`	`ClockMode`
`common_mode_offset`	float
`data_marker_events_count`	int
`data_marker_event_data_bit_number`	int
`data_marker_event_level_polarity`	`DataMarkerEventLevelPolarity`
`data_marker_event_output_terminal`	str
`data_transfer_block_size`	int
`data_transfer_maximum_bandwidth`	float
`data_transfer_maximum_in_flight_reads`	int
`data_transfer_preferred_packet_size`	int
`digital_data_mask`	int
`digital_edge_script_trigger_edge`	`ScriptTriggerDigitalEdgeEdge`
`digital_edge_script_trigger_source`	str
`digital_edge_start_trigger_edge`	`StartTriggerDigitalEdgeEdge`
`digital_edge_start_trigger_source`	str
`digital_filter_enabled`	bool
`digital_filter_interpolation_factor`	float
`digital_gain`	float
`digital_level_script_trigger_active_level`	`ScriptTriggerDigitalLevelActiveLevel`
`digital_level_script_trigger_source`	str
`digital_pattern_enabled`	bool
`digital_static_value`	int
`direct_dma_enabled`	bool
`direct_dma_window_address`	int
`direct_dma_window_size`	int
`done_event_delay`	float
`done_event_delay_units`	`DoneEventDelayUnits`
`done_event_latched_status`	bool
`done_event_level_active_level`	`DoneEventActiveLevel`
`done_event_output_behavior`	`DoneEventOutputBehavior`
`done_event_output_terminal`	str
`done_event_pulse_polarity`	`DoneEventPulsePolarity`
`done_event_pulse_width`	float
`done_event_pulse_width_units`	`DoneEventPulseWidthUnits`
`driver_setup`	str
`exported_onboard_reference_clock_output_terminal`	str
`exported_reference_clock_output_terminal`	str
`exported_sample_clock_divisor`	int
`exported_sample_clock_output_terminal`	str
`exported_sample_clock_timebase_divisor`	int
`exported_sample_clock_timebase_output_terminal`	str
`exported_script_trigger_output_terminal`	str
`exported_start_trigger_output_terminal`	str
`external_clock_delay_binary_value`	int
`external_sample_clock_multiplier`	float
`file_transfer_block_size`	int
`filter_correction_frequency`	float
`flatness_correction_enabled`	bool
`fpga_bitfile_path`	str
`freq_list_duration_quantum`	float
`freq_list_handle`	int
`func_amplitude`	float
`func_buffer_size`	int
`func_dc_offset`	float
`func_duty_cycle_high`	float
`func_frequency`	float
`func_max_buffer_size`	int
`func_start_phase`	float
`func_waveform`	`Waveform`
`gain_dac_value`	int
`group_capabilities`	str
`idle_behavior`	`IdleBehavior`
`idle_value`	int
`id_query_response`	str
`instrument_firmware_revision`	str
`instrument_manufacturer`	str
`instrument_model`	str
`interchange_check`	bool
`io_resource_descriptor`	str
`load_impedance`	float
`logical_name`	str
`major_version`	int
`marker_events_count`	int
`marker_event_delay`	float
`marker_event_delay_units`	`MarkerEventDelayUnits`
`marker_event_latched_status`	bool
`marker_event_live_status`	bool
`marker_event_output_behavior`	`MarkerEventOutputBehavior`
`marker_event_output_terminal`	str
`marker_event_pulse_polarity`	`MarkerEventPulsePolarity`
`marker_event_pulse_width`	float
`marker_event_pulse_width_units`	`MarkerEventPulseWidthUnits`
`marker_event_toggle_initial_state`	`MarkerEventToggleInitialState`
`max_freq_list_duration`	float
`max_freq_list_length`	int
`max_loop_count`	int
`max_num_freq_lists`	int
`max_num_sequences`	int
`max_num_waveforms`	int
`max_sequence_length`	int
`max_waveform_size`	int
`memory_size`	int
`minor_version`	int
`min_freq_list_duration`	float
`min_freq_list_length`	int
`min_sequence_length`	int
`min_waveform_size`	int
`module_revision`	str
`num_channels`	int
`offset_dac_value`	int
`oscillator_freq_dac_value`	int
`oscillator_phase_dac_value`	int
`osp_carrier_enabled`	bool
`osp_carrier_frequency`	float
`osp_carrier_phase_i`	float
`osp_carrier_phase_q`	float
`osp_cic_filter_enabled`	bool
`osp_cic_filter_gain`	float
`osp_cic_filter_interpolation`	float
`osp_compensate_for_filter_group_delay`	bool
`osp_data_processing_mode`	`DataProcessingMode`
`osp_enabled`	bool
`osp_fir_filter_enabled`	bool
`osp_fir_filter_flat_passband`	float
`osp_fir_filter_gaussian_bt`	float
`osp_fir_filter_interpolation`	float
`osp_fir_filter_raised_cosine_alpha`	float
`osp_fir_filter_root_raised_cosine_alpha`	float
`osp_fir_filter_type`	`FilterType`
`osp_frequency_shift`	float
`osp_mode`	`OSPMode`
`osp_overflow_error_reporting`	`OSPOverflowErrorReporting`
`osp_overflow_status`	int
`osp_pre_filter_gain_i`	float
`osp_pre_filter_gain_q`	float
`osp_pre_filter_offset_i`	float
`osp_pre_filter_offset_q`	float
`output_enabled`	bool
`output_impedance`	float
`output_mode`	`OutputMode`
`p2p_endpoint_fullness_start_trigger_level`	int
`pci_dma_optimizations_enabled`	bool
`post_amplifier_attenuation`	float
`pre_amplifier_attenuation`	float
`range_check`	bool
`ready_for_start_event_level_active_level`	`ReadyForStartEventActiveLevel`
`ready_for_start_event_live_status`	bool
`ready_for_start_event_output_terminal`	str
`record_coercions`	bool
`reference_clock_source`	`ReferenceClockSource`
`ref_clock_frequency`	float
`sample_clock_absolute_delay`	float
`sample_clock_source`	`SampleClockSource`
`sample_clock_timebase_rate`	float
`sample_clock_timebase_source`	`SampleClockTimebaseSource`
`script_to_generate`	str
`script_triggers_count`	int
`script_trigger_type`	`ScriptTriggerType`
`serial_number`	str
`simulate`	bool
`specific_driver_class_spec_major_version`	int
`specific_driver_class_spec_minor_version`	int
`specific_driver_description`	str
`specific_driver_revision`	str
`specific_driver_vendor`	str
`started_event_delay`	float
`started_event_delay_units`	`StartedEventDelayUnits`
`started_event_latched_status`	bool
`started_event_level_active_level`	`StartedEventActiveLevel`
`started_event_output_behavior`	`StartedEventOutputBehavior`
`started_event_output_terminal`	str
`started_event_pulse_polarity`	`StartedEventPulsePolarity`
`started_event_pulse_width`	float
`started_event_pulse_width_units`	`StartedEventPulseWidthUnits`
`start_trigger_type`	`StartTriggerType`
`streaming_space_available_in_waveform`	int
`streaming_waveform_handle`	int
`streaming_waveform_name`	str
`streaming_write_timeout`	float in seconds or datetime.timedelta
`supported_instrument_models`	str
`synchronization`	`SynchronizationSource`
`sync_duty_cycle_high`	float
`sync_out_output_terminal`	str
`terminal_configuration`	`TerminalConfiguration`
`trigger_mode`	`TriggerMode`
`trigger_source`	`TriggerSource`
`video_waveform_type`	`VideoWaveformType`
`wait_behavior`	`WaitBehavior`
`wait_value`	int
`waveform_quantum`	int

Public methods

Method name
`abort()`
`allocate_named_waveform()`
`allocate_waveform()`
`clear_arb_memory()`
`clear_arb_sequence()`
`clear_arb_waveform()`
`clear_freq_list()`
`clear_user_standard_waveform()`
`commit()`
`configure_arb_sequence()`
`configure_arb_waveform()`
`configure_custom_fir_filter_coefficients()`
`configure_digital_edge_script_trigger()`
`configure_digital_edge_start_trigger()`
`configure_digital_level_script_trigger()`
`configure_freq_list()`
`configure_standard_waveform()`
`create_advanced_arb_sequence()`
`create_arb_sequence()`
`create_freq_list()`
`create_waveform_from_file_f64()`
`create_waveform_from_file_i16()`
`create_waveform_numpy()`
`define_user_standard_waveform()`
`delete_named_waveform()`
`delete_script()`
`disable()`
`export_signal()`
`get_ext_cal_last_date_and_time()`
`get_ext_cal_last_temp()`
`get_ext_cal_recommended_interval()`
`get_fir_filter_coefficients()`
`get_hardware_state()`
`get_self_cal_last_date_and_time()`
`get_self_cal_last_temp()`
`get_self_cal_supported()`
`is_done()`
`query_arb_seq_capabilities()`
`query_arb_wfm_capabilities()`
`query_freq_list_capabilities()`
`read_current_temperature()`
`reset()`
`reset_device()`
`reset_with_defaults()`
`self_cal()`
`self_test()`
`send_software_edge_trigger()`
`set_named_waveform_next_write_position()`
`set_waveform_next_write_position()`
`wait_until_done()`
`write_script()`
`write_waveform()`