removeProfile

Remove data of impedance profile from EISTest object

Since R2025a

collapse all in page

Syntax

removeProfile(eistest,profileId)

Description

removeProfile(eistest,profileId) removes the data of an impedance profile inside the EISTest object, eistest. The profileId index refers to the index of the tabulated profiles in the TestSummary property table of the EISTest object.

example

Examples

collapse all

This example shows how to remove all data of a specific impedance profile from an EISTest object.

Open the DownloadBatteryEISData example and load the required EIS data. This data has been generated from a battery with a nominal capacity of 30/1000 A*Hr at a temperature of 25 °C. This data consists of a 500-by-3 matrix of doubles. The columns of the matrix refer to the frequency, real impedance, and imaginary impedance values, respectively.

openExample("simscapebattery/DownloadBatteryEISDataExample")
load("generatedEISData.mat")

Store the EIS data inside an EISTest object by using the eisTest function. You can use this object to automatically extract and analyze individual impedance profiles from EIS frequency-based data.

eisExp = eisTest(eisData);

Analyze the TestSummary property of the eisExp object. This property contains a summary of the EIS test that shows all the identified profiles and related data, returned as a table.

eisExp.TestSummary
ans =

  5×7 table

    ProfileID    ImpedanceData    Breakpoint1    Breakpoint2    Breakpoint3    ProfileStartIndex    ProfileEndIndex
    _________    _____________    ___________    ___________    ___________    _________________    _______________

        1        {87×3 double}         1             25              1                  1                 100      
        2        {87×3 double}         2             25              1                101                 200      
        3        {87×3 double}         3             25              1                201                 300      
        4        {87×3 double}         4             25              1                301                 400      
        5        {87×3 double}         5             25              1                401                 500

Remove the first profile in the TestSummary table by using the removeProfile function.

removeProfile(eisExp,1)

View the effects of the removeProfile function by using the TestSummary property again. The function successfully removed the first profile from the table.

eisExp.TestSummary
  4×7 table

    ProfileID    ImpedanceData    Breakpoint1    Breakpoint2    Breakpoint3    ProfileStartIndex    ProfileEndIndex
    _________    _____________    ___________    ___________    ___________    _________________    _______________

        1        {87×3 double}         1             25              1                101                 200      
        2        {87×3 double}         2             25              1                201                 300      
        3        {87×3 double}         3             25              1                301                 400      
        4        {87×3 double}         4             25              1                401                 500

Input Arguments

collapse all

Electrochemical impedance spectroscopy (EIS) test object that contains the impedance profile to remove, specified as an EISTest object.

Index of the tabulated profile inside the TestSummary property table of the EISTest object, specified as a scalar.

Data Types: double

Version History

Introduced in R2025a

See Also

| | |