Compare

Comparing IMX Containers and Situations¶

Using the ImxSingleFile and ImxMultiRepo classes, you can seamlessly compare IMX containers or specific scenarios across different versions of the IMX format. Objects sharing the same PUIC are recognized as identical, which simplifies comparisons across various contexts and versions.

We leverage Pandas to manage tabular data, facilitating the analysis and export of comparison results to Excel. Our implementation features custom diff operators tailored for IMX data, and we enhance visualization with color-coded styles on output borders, allowing for quick identification of discrepancies.

While we support comparisons between different IMX versions, this feature requires explicit selection. Below, we have some sample code to illustrate how to use these classes effectively:

MultiRepo¶

If IMX objects share the same unique key (puic) this is used to collect multiple instances in different containers. The order is crucial for comparison. Currently, we support more than two containers, but the diff is limited to A vs. B. Timeline comparisons will be supported in the future.

First we need to create a multy repo, then we need to get the compare.

SingleImxContainerImxDifferent IMX version

from imxInsights import ImxMultiRepo, ImxSingleFile


imx = ImxSingleFile(r"path to xml file")

# create multi repo
multi_repo = ImxMultiRepo(
    [
        imx.initial_situation,
        imx.new_situation,
    ]
)

# compare
compared_imx = multi_repo.compare()

from imxInsights import ImxContainer, ImxMultiRepo


imx_a = ImxContainer(r"path to xml zip container or folder")
imx_b = ImxContainer(r"path to xml zip container or folder")

# create multi repo
multi_repo = ImxMultiRepo(
    [
        imx_a,
        imx_b,
    ]
)

# compare
compared_imx = multi_repo.compare()

from imxInsights import ImxSingleFile, ImxContainer, ImxMultiRepo


imx_a = ImxSingleFile(r"path to xml file")
imx_b = ImxContainer(r"path to xml zip container or folder")

# create multi repo
multi_repo = ImxMultiRepo(
    [
        imx_a,
        imx_b,
    ],
    version_safe=False,
)

# compare
compared_imx = multi_repo.compare()

Get pandas dataframe¶

Each row represents an IMX object, while the columns denote the attribute or element values. We utilize the IMX path to identify an object type or generate an Excel report of all paths. For added items, we prefix them with ++, for deleted items -- and for changes we denote changes with ->.

We use color highlighting to detect changes in dataframes and Excel exports. This visual aid helps easily spot differences between values, making data comparison more efficient and user-friendly.

# get object type specific diff dataframe
track_diff_dataframe = compared_imx.get_pandas(object_type='Track')

# optional add analyses and style
track_diff_dataframe_colored = compared_imx.get_pandas(
    object_type='Track', add_analyse=True, styled_df=True
)

Excel¶

It is what it is... the world still runs on Excel, so we've provided an Excel output.

# create excel
compared_imx.create_excel(
    file_path="diff_excel.xlsx",
    add_analyse=True, styled_df=True
)

GeoJSON¶

Basically the same as a DataFrame, but when GML coordinates are present, they also include geometry. RailConnections are supported, and future features will include other objects without GML.

# get geojson feature collection from type
feature_collection = compared_imx.get_geojson(
    object_paths=["Signal", "Signal.ReflectorPost"]
)

# create geojson files
compared_imx.create_geojson_files(directory_path="geojson_diff")