Close File

CLOSE_FILE_SINGLE

Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = -1
```

Frontend sends: OPEN_FILE (OpenFile)

directory = "set_QA"
file = "M17_SWex.fits"
hdu = ""
file_id = 0
render_mode = RASTER

Backend returns: OPEN_FILE_ACK (OpenFileAck) and REGION_HISTOGRAM_DATA

Check 1: the OPEN_FILE_ACK should satisfy:

OPEN_FILE_ACK.success = True

OPEN_FILE_ACK.file_info.name = “M17_SWex.fits”

Frontend sends: ADD_REQUIRED_TILES (AddRequiredTiles)

file_id = 0
compression_quality = 11
compression_type = ZFP
tiles = [0]

Frontend sends: SET_CURSOR and SET_SPATIAL_REQUIREMENTS
```
file_id = 0
point = {x: 1, y: 1}
```
Backend returns: RASTER_TILE_DATA and SPATIAL_PROFILE_DATA

Check 2: the RASTER_TILE_DATA stream should satisfy:

Total length = 3 (RasterTileSync start + 1 tile + RasterTileSync end)

Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = 0
```

Check 3: after closing the file:

No additional messages should be received from the backend (message count should not change after 1000 ms)

Check 4: the backend should remain alive:

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

CLOSE_FILE_ANIMATION

See the source code.

Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = -1
```

Frontend sends: OPEN_FILE (OpenFile)

directory = "set_QA"
file = "M17_SWex.fits"
hdu = "0"
file_id = 0
render_mode = RASTER

Backend returns: OPEN_FILE_ACK (OpenFileAck) and REGION_HISTOGRAM_DATA

Check 1: the OPEN_FILE_ACK should satisfy:

OPEN_FILE_ACK.success = True

OPEN_FILE_ACK.file_info.name = “M17_SWex.fits”

Frontend sends: ADD_REQUIRED_TILES (AddRequiredTiles)

file_id = 0
compression_quality = 11
compression_type = ZFP
tiles = [33558529, 33558528, 33562625, 33554433, 33562624,
         33558530, 33554432, 33562626, 33554434, 33566721,
         33566720, 33566722]

Frontend sends: SET_CURSOR and SET_SPATIAL_REQUIREMENTS
```
file_id = 0
point = {x: 320, y: 400}
```
Backend returns: RASTER_TILE_DATA stream (12 tiles + 2 sync = 14 messages)

Check 2: the RASTER_TILE_DATA stream should satisfy:

Total length = 14 (12 tiles + RasterTileSync start + RasterTileSync end)

Frontend sends: START_ANIMATION (StartAnimation)

file_id = 0
start_frame = {channel: 1, stokes: 0}
first_frame = {channel: 0, stokes: 0}
last_frame = {channel: 24, stokes: 0}
delta_frame = {channel: 1, stokes: 0}
required_tiles = {file_id: 0, tiles: [12 tiles], compression_type: ZFP, compression_quality: 9}
looping = true
reverse = false
frame_rate = 5

Backend returns: START_ANIMATION_ACK (StartAnimationAck)

Check 3: the START_ANIMATION_ACK should satisfy:

START_ANIMATION_ACK.success = True

Animation plays for 2 channel frames with ANIMATION_FLOW_CONTROL sent per frame
Frontend sends: CLOSE_FILE (CloseFile) during animation (without STOP_ANIMATION)
```
file_id = 0
```

Check 4: after closing the file during animation:

The backend should remain alive

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

CLOSE_FILE_ERROR

See the source code.

Case 1: Requesting ICD message of a closed file

Frontend sends: OPEN_FILE (OpenFile) for two files

File 1:

directory = "set_QA"
file = "M17_SWex.fits"
hdu = "0"
file_id = 0
render_mode = RASTER

File 2:

directory = "set_QA"
file = "M17_SWex.hdf5"
hdu = "0"
file_id = 1
render_mode = RASTER

Backend returns: OPEN_FILE_ACK for each file

Check 1: both OPEN_FILE_ACK should satisfy:

success = True

Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = 1
```
Frontend sends: SET_CURSOR targeting the closed file
```
file_id = 1
point = {x: 1, y: 1}
```
Backend returns: ERROR_DATA (ErrorData)

Check 2: the ERROR_DATA should satisfy:

tags = ["cursor"]
message = "File id 1 not found"

Check 3: the backend should remain alive:

FILE_LIST_RESPONSE.success = True

Check 4: file_id = 0 should still function normally:

ADD_REQUIRED_TILES, SET_CURSOR, and SET_SPATIAL_REQUIREMENTS should all receive valid responses

RASTER_TILE_DATA stream length = 3

Case 2: Open → Close → Reopen cycle

Frontend sends: OPEN_FILE (file_id = 0), loads tiles and sets cursor
Frontend sends: CLOSE_FILE (file_id = 0)
Frontend sends: OPEN_FILE again (same file, file_id = 0)

Check 5: the reopened file should function normally:

OPEN_FILE_ACK.success = True

ADD_REQUIRED_TILES, SET_CURSOR, and SET_SPATIAL_REQUIREMENTS receive valid responses

RASTER_TILE_DATA stream length = 3

Check 6: the backend should remain alive after the cycle:

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

CLOSE_FILE_SPECTRAL_PROFILE

See the source code.

Case 1: Close during single image spectral profile streaming

Frontend sends: OPEN_FILE (OpenFile)

directory = "set_QA"
file = "S255_IR_sci.spw29.cube.I.pbcor.fits"
hdu = "0"
file_id = 0
render_mode = RASTER

Backend returns: OPEN_FILE_ACK and REGION_HISTOGRAM_DATA

Check 1: the OPEN_FILE_ACK should satisfy:

success = True

Frontend loads tiles, sets cursor and spatial requirements

Frontend sends: SET_REGION (SetRegion)

file_id = 0
region_id = -1
region_info = {
    region_type = RECTANGLE,
    control_points = [{x: 630.0, y: 1060.0}, {x: 600.0, y: 890.0}],
    rotation = 0.0
}

Backend returns: SET_REGION_ACK (SetRegionAck)

Check 2: the SET_REGION_ACK should satisfy:

success = True
region_id = 1

Frontend sends: SET_SPECTRAL_REQUIREMENTS (SetSpectralRequirements)

file_id = 0
region_id = 1
spectral_profiles = [{coordinate: "z", stats_types: [Mean]}]

Backend streams: SPECTRAL_PROFILE_DATA with increasing progress
Once progress > 0.3, Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = 0
```

Check 3: after closing the file during spectral profile streaming:

The backend should remain alive

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

Case 2: Close during dual image spectral profile streaming

Frontend opens two images:

file = "S255_IR_sci.spw29.cube.I.pbcor.fits"  (file_id = 0)
file = "S255_IR_sci.spw25.cube.I.pbcor.fits"  (file_id = 1)

Frontend loads tiles and sets up spatial requirements for both images
Frontend sends: SET_REGION on file_id = 0

Frontend sends: SET_SPECTRAL_REQUIREMENTS on file_id = 0

file_id = 0
region_id = 1
spectral_profiles = [{coordinate: "z", stats_types: [Mean]}]

Once progress > 0.3, cancel first image spectral requirements

Frontend sends: SET_SPECTRAL_REQUIREMENTS on file_id = 1 (via matching region)

file_id = 1
region_id = 1
spectral_profiles = [{coordinate: "z", stats_types: [Mean]}]

Once progress > 0.3, Frontend sends: CLOSE_FILE for both images
```
file_id = 0
file_id = 1
```

Check 4: after closing both files:

No additional messages should be received from the backend

Check 5: the backend should remain alive:

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

CLOSE_FILE_TILE

See the source code.

Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = -1
```

Frontend sends: OPEN_FILE (OpenFile)

directory = "set_QA"
file = "M17_SWex.fits"
hdu = ""
file_id = 0
render_mode = RASTER

Backend returns: OPEN_FILE_ACK and REGION_HISTOGRAM_DATA

Check 1: the OPEN_FILE_ACK should satisfy:

success = True

Frontend sends: ADD_REQUIRED_TILES (AddRequiredTiles)

file_id = 0
compression_quality = 11
compression_type = ZFP
tiles = [0]

Frontend sends: SET_CURSOR and SET_SPATIAL_REQUIREMENTS
```
file_id = 0
point = {x: 1, y: 1}
```
Backend returns: RASTER_TILE_DATA and SPATIAL_PROFILE_DATA

Check 2: the RASTER_TILE_DATA stream should satisfy:

Total length = 3 (RasterTileSync start + 1 tile + RasterTileSync end)

Frontend sends: SET_IMAGE_CHANNELS (SetImageChannels) to trigger large tile streaming

file_id = 0
channel = 10
stokes = 0
required_tiles = {
    file_id: 0,
    compression_type: ZFP,
    compression_quality: 11,
    tiles: [33558529, 33558528, 33562625, 33554433, 33562624,
            33558530, 33554432, 33562626, 33554434, 33566721,
            33566720, 33566722]
}

During tile streaming, Frontend sends: CLOSE_FILE (CloseFile)
```
file_id = 0
```

Check 3: after closing the file during tile streaming:

The backend should remain alive

FILE_LIST_RESPONSE.success = True

FILE_LIST_RESPONSE.directory should contain “set_QA”

CLOSE_FILE_MULTI_FILES

See the source code.

This test verifies that multiple files can be closed in various orders and combinations, and that the backend remains alive and responsive after each scenario.

Frontend sends: OPEN_FILE (OpenFile) for 3 files

file = "M17_SWex.fits", file_id = 0
file = "M17_SWex.hdf5", file_id = 1
file = "M17_SWex.image", file_id = 2

Backend returns: OPEN_FILE_ACK and REGION_HISTOGRAM_DATA for each file
For each file: Frontend sends ADD_REQUIRED_TILES, SET_CURSOR, and SET_SPATIAL_REQUIREMENTS

Case 1: Close files in reverse order (2 -> 1 -> 0)

Frontend sends: CLOSE_FILE (file_id = 2), then verifies remaining files respond to spatial requirements
Frontend sends: CLOSE_FILE (file_id = 1), then verifies remaining file responds
Frontend sends: CLOSE_FILE (file_id = 0)

Check 1: after all files closed:

Backend should remain alive: FILE_LIST_RESPONSE.success = True

No additional ICD messages should arrive (message count stable for 500 ms)

Case 2: Close two files simultaneously, then close the last

Reopen all 3 files with the same setup
Frontend sends: CLOSE_FILE (file_id = 0) and CLOSE_FILE (file_id = 1) simultaneously

Check 2: after simultaneous close:

No additional ICD messages should arrive (message count stable for 500 ms)

Frontend sends: CLOSE_FILE (file_id = 2)

Check 3: the backend should remain alive:

FILE_LIST_RESPONSE.success = True

Case 3: Close all three files simultaneously

Reopen all 3 files with the same setup
Frontend sends: CLOSE_FILE for file_id = 0, 1, and 2 simultaneously

Check 4: after simultaneous close of all files:

Backend should remain alive: FILE_LIST_RESPONSE.success = True

No additional ICD messages should arrive (message count stable for 500 ms)