should `eachslice` return a `DimArray`?

[simeonschaub]

I think it would be useful if eachslice did something like the following, so the resulting slices array kept the sliced dimension:

function eachslice2(x::AbstractDimArray; dims, drop=true)
    dim = DimensionalData.dims(x, dims)
    return DimArray(eachslice(x; dims, drop), dim)
end

Does this sound reasonable?

[asinghvi17]

AFAIK this is why refdims exists in dimarrays, maybe each slice just needs to add that?

[asinghvi17]

https://github.com/JuliaLang/julia/blob/8593792f8f5212d5513fe0829253664c3ceedd2a/base/slicearray.jl#L228-L245 is the code in Base that does this - we'd simply have to reimplement this for a DimSlices struct here, that would return rebuilt / modify'ed (?) versions of the dimarray (since this should be global to Rasters, YAXArrays, etc), with refdims set to the correct value.

DD already defines Base _eachchunk in methods.jl for arrays and stacks

[simeonschaub]

JuliaLang/julia@8593792/base/slicearray.jl#L228-L245 is the code in Base that does this - we'd simply have to reimplement this for a DimSlices struct here, that would return rebuilt / modify'ed (?) versions of the dimarray (since this should be global to Rasters, YAXArrays, etc), with refdims set to the correct value.

Could you elaborate on what this would look like?

[rafaqz]

Basically we have DimSlices here already for this, but we don't use this for eachslice on AbstractDimArray to be consistent with Base. We use it for DimStack where Slices limits the type to AbstractArray.

I think @sethaxen had a reason for not using DimSlices for both.

But we could shift to using DimSlices for AbstractDimArray as well, then you could index by dimensions. The question is how much are other packages expecting a Slices object from eachslice and does it matter.

[rafaqz]

@simeonschaub do you have thoughts on what the expected return type of eachslice is, and if it matters much?

[simeonschaub]

For my use case it would be really nice if eachslice returned a DimSlices object, I didn't know that already existed. Having base functions on AbstractDimArray return AbstractDimArrays as well seems like the most useful behavior to me, since it's always annoying to lose axis information and having to manually add it back.

[rafaqz]

Yeah, it makes sense.

I think this wording of the docs is the main problem, it specifically says it returns a Slices object for AbstractArray:

help?> eachslice
search: eachslice eachsplit

  eachslice(A::AbstractArray; dims, drop=true)

  Create a Slices object that is an array of slices over dimensions dims of A

We can't even make it <: AbstractSlices without a lot of work to make dimension indexing work on it, as it needs to be AbstractDimArrayGenerator to get everything for free.