FilterPy

SCPI Commands :

[SOURce<HW>]:BB:OFDM:FILTer:CUTTrans
[SOURce<HW>]:BB:OFDM:FILTer:LENGth
[SOURce<HW>]:BB:OFDM:FILTer:ROLLoff
[SOURce<HW>]:BB:OFDM:FILTer:SBATtenuation
[SOURce<HW>]:BB:OFDM:FILTer:TYPE
[SOURce<HW>]:BB:OFDM:FILTer:UCATalog
[SOURce<HW>]:BB:OFDM:FILTer:ULENgth
[SOURce<HW>]:BB:OFDM:FILTer:USELection
[SOURce<HW>]:BB:OFDM:FILTer:WINDowing

class FilterPyCls

FilterPy commands group definition. 9 total commands, 0 Subgroups, 9 group commands

get_cut_trans() → bool

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:CUTTrans
value: bool = driver.source.bb.ofdm.filterPy.get_cut_trans()

Cuts the transient response of the filtering operation at the beginning and end of the signal.

return:

cut_trans_resp: 1| ON| 0| OFF

get_length() → int

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:LENGth
value: int = driver.source.bb.ofdm.filterPy.get_length()

Sets the filter length.

return:

filter_length: integer Range: 1 to 800

get_rolloff() → float

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:ROLLoff
value: float = driver.source.bb.ofdm.filterPy.get_rolloff()

Sets the filter parameter.

return:

rolloff: float Range: 0 to 1

get_sb_attenuation() → float

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:SBATtenuation
value: float = driver.source.bb.ofdm.filterPy.get_sb_attenuation()

Sets the attenuation in the filter stop band.

return:

stb_attenuation: float Range: 10 to 120

get_type_py() → C5GfiltT

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:TYPE
value: enums.C5GfiltT = driver.source.bb.ofdm.filterPy.get_type_py()

Sets the baseband filter type. .

return:

filter_type: RC| RRC| DIRichlet| RECT| DCH| STRunc| USER| PHYDyas| NONE RC|DIRichlet|RECT Requires modulation type GFDM. Raised cosine filter, Dirichlet filter or rectangular filter RRC Requires modulation types FBMC or GFDM. Root raised cosine filter DCH Requires modulation type UFMC. Dolph-Chebyshev filter STRunc Requires modulation type f-OFDM. Soft truncation filter USER Requires modulation types OFDM, f-OFDM or UFMC. User-defined filter from a file. See also ‘User filter file format (*.dat files) ‘. PHYDyas Requires modulation type FBMC. Phydyas filter NONE Requires modulation types OFDM or f-OFDM. No filtering applied.

get_ucatalog() → List[str]

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:UCATalog
value: List[str] = driver.source.bb.ofdm.filterPy.get_ucatalog()

Queries the user filter files in the default directory. Only files with the file extension *.dat are listed.

return:

c_5_gfilter_cat_name: No help available

get_ulength() → int

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:ULENgth
value: int = driver.source.bb.ofdm.filterPy.get_ulength()

Queries the filter length.

return:

user_filter_len: integer Range: 1 to 800

get_uselection() → str

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:USELection
value: str = driver.source.bb.ofdm.filterPy.get_uselection()

Loads the selected file from the default or the specified directory. Loaded are files with extension *.dat. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

return:

user_sel: string Complete file path including file name and file extension

get_windowing() → C5GfilterWind

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:WINDowing
value: enums.C5GfilterWind = driver.source.bb.ofdm.filterPy.get_windowing()

Sets the windowing method.

return:

windowing: NONE| HANNing| HAMMing

set_cut_trans(cut_trans_resp: bool) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:CUTTrans
driver.source.bb.ofdm.filterPy.set_cut_trans(cut_trans_resp = False)

Cuts the transient response of the filtering operation at the beginning and end of the signal.

param cut_trans_resp:

1| ON| 0| OFF

set_length(filter_length: int) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:LENGth
driver.source.bb.ofdm.filterPy.set_length(filter_length = 1)

Sets the filter length.

param filter_length:

integer Range: 1 to 800

set_rolloff(rolloff: float) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:ROLLoff
driver.source.bb.ofdm.filterPy.set_rolloff(rolloff = 1.0)

Sets the filter parameter.

param rolloff:

float Range: 0 to 1

set_sb_attenuation(stb_attenuation: float) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:SBATtenuation
driver.source.bb.ofdm.filterPy.set_sb_attenuation(stb_attenuation = 1.0)

Sets the attenuation in the filter stop band.

param stb_attenuation:

float Range: 10 to 120

set_type_py(filter_type: C5GfiltT) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:TYPE
driver.source.bb.ofdm.filterPy.set_type_py(filter_type = enums.C5GfiltT.DCH)

Sets the baseband filter type. .

param filter_type:

RC| RRC| DIRichlet| RECT| DCH| STRunc| USER| PHYDyas| NONE RC|DIRichlet|RECT Requires modulation type GFDM. Raised cosine filter, Dirichlet filter or rectangular filter RRC Requires modulation types FBMC or GFDM. Root raised cosine filter DCH Requires modulation type UFMC. Dolph-Chebyshev filter STRunc Requires modulation type f-OFDM. Soft truncation filter USER Requires modulation types OFDM, f-OFDM or UFMC. User-defined filter from a file. See also ‘User filter file format (*.dat files) ‘. PHYDyas Requires modulation type FBMC. Phydyas filter NONE Requires modulation types OFDM or f-OFDM. No filtering applied.

set_uselection(user_sel: str) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:USELection
driver.source.bb.ofdm.filterPy.set_uselection(user_sel = 'abc')

Loads the selected file from the default or the specified directory. Loaded are files with extension *.dat. Refer to ‘Accessing Files in the Default or Specified Directory’ for general information on file handling in the default and in a specific directory.

param user_sel:

string Complete file path including file name and file extension

set_windowing(windowing: C5GfilterWind) → None

# SCPI: [SOURce<HW>]:BB:OFDM:FILTer:WINDowing
driver.source.bb.ofdm.filterPy.set_windowing(windowing = enums.C5GfilterWind.HAMMing)

Sets the windowing method.

param windowing:

NONE| HANNing| HAMMing