[Feature] Use .brainglobe directory to store deformations

[PolarBean]

would .brainglobe/deformations be a good directory from me to store the data @adamltyson?

[PolarBean]

Alternatively I could store the deformation in the directory of the atlas, in the same folders as the atlas files. I'll review the v2 spec and start conforming to this

[adamltyson]

brainglobe/deformations seems good to me. I would avoid adding to the atlas directories themselves, so we don't have to worry about overwriting them.

[PolarBean]

and for versioning is it best to add just a _v1.0 string to the end of filenames. This is what atlasapi does, is it something you want to continue doing?

[adamltyson]

Yeah, for now. We can/should revisit once the API itself is updated.

add just a _v1.0 string

I assume you mean add the actual version, not just _v1.0!

[PolarBean]

well all the versions now will be v1.0! as it would just be versioning for the deformation matrix. But yeah in the future if the deformations are updated we would update the version number.

One issue is that there are versions of spaces and versions of deformations... This might get confusing

[adamltyson]

Oh yeah, I misunderstood. Should a deformation version be a combination of space versions? I.e. a specific deformation version for specific versions of source and target spaces?

[PolarBean]

Yes I think so. But in addition you might want to improve a deformation so you would need to version that too. So there are three versions that need to be specified.
somthing like:
CCF_stpt_v1.3_to_Gubra_LSFM_v1.2_deformation_v2

[PolarBean]

but then again I assume the space won't update without changing it's name entirely??

[PolarBean]

if there was theoretically a ccfv4 based on MRI. would this still be allen_mouse in the brainglobe api

[adamltyson]

if there was theoretically a ccfv4 based on MRI. would this still be allen_mouse in the brainglobe api

I guess it depends if the space changes, or just the reference image.

Realistically, all of this should/will change with atlas API V2, but that is likely to be some time off.