pycalibration package

Submodules

pycalibration.curve module

class pycalibration.curve.Curve(x, y)

Bases: object

Curve allow the defintion and extroplation of data of a curve

This class is usually returned by the DCM class after importing a file.

insert(x, y)

Insert a point in the curve

Parameters

• x – x value of the point

• y – y value of the point

Returns

None

y(x)

return the y value of a curve given the x value.

Values are interpolated between the points given

pycalibration.engine module

class pycalibration.engine.Engine(n=[600, 1000, 2000, 4000, 6000], t=[100, 500, 1000, 800, 100])

Bases: object

Class engine offers support for engine calculation and estimation.

npower(power)

power(speed, limit=100)

Return the Power at a given engine speed and a percentage torque :param speed: engine speed in rpm :param limit: max percentage torque :return: engie power in watts

torque(speed, limit=100)

Return the torque at an engine speed with a max percentage torque ( 100% is full torque) :param speed: engine speed in rpm :param limit: maximum percent torque from curve :return: engine torque in Nm

pycalibration.extract module

class pycalibration.extract.Extract

Bases: MDF

Extract class extract channels from single or multiple files

add_directory(pathname)

Add a directory recursively to the files to be processed. Files recognize are mdf and mf4 exensions

Parameters

path – path to be added

Returns

none

add_file(filename)

Add single file to the list of files to be processed

Parameters

file – file name path to the file

Returns

none

get()

Read the MDF files and retrieved the requested data.

Returns

list of pandas dataframe contaiing the datas.

pycalibration.function module

class pycalibration.function.Function

Bases: Extract

Base class to define function in module

Based on Extract, it supoprt all the extract method. It is necessary to set the files or directory to process before calling the process method.

Evaluate method should be overwritten for data evaluation related to the function beeing developed.

evaluate(data)

Using the data retrieved from the measurement file, generate calibration This method should be over writen by the derivative class and returns what ever the evaluation is producing.

Returns

should return the evaluation data

lab()

Write the labels and parameters in a lab file

Returns

None

process()

Retrieve the necessary information from the measurment files.

Returns

list containing files processed results

pycalibration.gearbox module

class pycalibration.gearbox.Gearbox(n=[1, 2, 3, 4, 5], r=[10, 9, 8, 7, 6])

Bases: object

Gearbox class Class provide interface to get the gear ratio on a given gear

ratio(gear)

Return the gear ratio for a given gear :param gear: gear number :return: gear ratio

pycalibration.map module

class pycalibration.map.Map(x, y, z)

Bases: object

x(y, z)

y(x, z)

z(x, y)

pycalibration.mdf module

class pycalibration.mdf.MDF(filename=None)

Bases: object

MDF class to handle MDF read operation

add_channel(channel, rename='', inter=False)

Set a channel to be retrieved from the MDF. If a rename name is supplied, the channels will be reneamed. If more than one channel as the same rename name, all channels will be checked until one available is found. Interpolation should not be used on digitial signal. The interpolation is linear and should be used on non digitial signals to improve accuracy lf signal in measurement with multiple time raster.

Parameters

• channel – channel name

• rename – name to be renamed to

• inter – Set to True to interpolate missing values, default False.

Returns

None

get_channel(channel)

Get the data designated by the channel name

Parameters

channel – channel name

Returns

pandas dataframe containing the data

get_data()

Read the MDF file and retrieved the requested data

Parameters

filename – filename ( with full path ) of the MDF file to open

Returns

pandas dataframe containing the datas. The time offset for the channels is set to the column offset. The dataframe indes is based on the file timestamp with the measurement time offset. This allows datetime operation on the dataframe.

set_file(filename)

pycalibration.resistance module

class pycalibration.resistance.Resistance(cx=0, fr=0, ro=0)

Bases: object

This class calculates the vehicle driving resistance

fair(v)

Return the air resisting force :param v: vehicle speed in m/s :return: air resisting force in N

fpitch(m, grade)

Return the pitch resisting force at a specified pitch :param m: total vehicle mass in kg :param pitch: slope in percentage :return: pitch resisting force in N

frolling(m, grade)

Return the rolling resisting force :param m: total vehicle mass in kg :param pitch: slope in percentage :return: rolling resisting force in N

resistance(v, m, grade=0)

Return the sum of air, pitch and rolling resisting force :param v: vehicle speed in m/s :param m: total vehicle mass in kg :param grade: slope in percentage :return: total resisting force in N

pycalibration.shift module

class pycalibration.shift.Shift

Bases: object

Generate Table bevore and after shifting All the columns supplied in the data for process will be used. At the beginning of the shift, the columns will be added ‘_pre’, at the end of the shift ‘_post’.

process(data)

Process the data and return the table containing the shifts.

Parameters

data – pandas Dataframe containing the data, inclusive the channel to be used to detect the shift

Returns

Pandas dataframe containing the pre and post shifts data.

set_post(post, up=False)

Set the post channel used for trigger

Parameters

• pre – Channel name to be used as trigger

• up – Determine the signal direction ( up/down, up by default )

set_pre(pre, up=True)

Set the pre channel used for trigger

Parameters

• pre – Channel name to be used as trigger

• up – Determine the signal direction ( up/down, up by default )

pycalibration.trigger module

class pycalibration.trigger.Trigger

Bases: object

Generate Table at the time of the event. The event shall be generated from a digital signal

process(data)

Process the data and returns the events in a pandas dataframe

Parameters

data – data to be analysed

Returns

pandas dataframe with all the signals and events

set_trigger(name, up=True)

Set the name of the trigger signal

Parameters

• name – name of the signal to be used as trigger ( digital )

• up – True if the event is rising

Returns

None

pycalibration.value module

class pycalibration.value.Value(x, y=None, z=None)

Bases: object

Value class represent the informations stored in a parameter. Each value can be a single value, a curve or a map. All points are interpolated

x(pos)

Return the X value at a position ( interpolated from the array) :param pos: position in the array :return: X value

y(x)

Return the Y value at a X position ( interpolated from the array) :param pos: position in the array :return: Y value

z(x, y)

Return the Z value at a X,Y position ( interpolated from the array) :param pos: position in the array :return: Z value

pycalibration.vbo module

class pycalibration.vbo.VBO

Bases: object

read(filename)

pycalibration.vehicle module

class pycalibration.vehicle.Vehicle

Bases: object

class to represent a vehicle and basic calulation for the vehicle configuration

energy(n, gear, mass)

engine_to_speed(engine, gear)

Returns the vehicle speed from the engine speed and the common powertrain ratio :param engine: engine speed in 1/min :param gear: gear number :return: vehicle speed in m/s

force_to_torque(f, gear)

Returns the engine torque from the traction force and the common powertrain ratio :param f: traction force in N :param ratio: common powertrain ratio :return: engine torque in Nm

fresist(speed, mass, grade=0)

Returns the resistance force by entering the vehicle speed and the ratio (default ratio = 1) :param speed: vehicle speed in m/s :param mass: total vehicle mass in kg :param grade: road grade :return: resistance force in N

ratio(gear)

return the gear ration from the given gear

Parameters

gear – gear number

Returns

trans ratio (gear and rear axle ratio)

speed_to_engine(speed, gear)

Returns the engine speed from the vehicle speed and the common powertrain ratio :param speed: vehicle speed in m/s :param gear: gear number :return: engine speed in 1/min

torque(n, pedal=100)

By default, this function returns the torque at an engine speed with a max percentage torque (100% is full torque) :param n: engine speed in rpm :param pedal: percentage value of the accelerator pedal; default 100% means full torque :return: engine torque in Nm

torque_to_force(t, gear)

Returns the traction force from the engine torque and the common powertrain ratio :param t: engine torque in Nm :param ratio: common powertrain ratio :return: traction force in N

pycalibration.watchdog module

class pycalibration.watchdog.Watchdog(queue, path='.')

Bases: FileSystemEventHandler

on_created(event)

Called when a file or directory is created.

Parameters

event (DirCreatedEvent or FileCreatedEvent) – Event representing file/directory creation.

on_moved(event)

Called when a file or a directory is moved or renamed.

Parameters

event (DirMovedEvent or FileMovedEvent) – Event representing file/directory movement.

process(path)

start()

stop()

Module contents